summaryrefslogtreecommitdiffstats
path: root/libc/docs/stdbit.rst
blob: 9b4974cf1479b1682e3301c1a5ba30756ca1a304 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
=========================
Bitwise Utility Functions
=========================

.. include:: check.rst

---------------
Source Location
---------------

-   The main source for bitwise utility functions is located at:
    ``libc/src/stdbit``.

-   The source for internal helpers used to implement these is located at:
    ``libc/src/__support/CPP/bit.h``.

-   The tests are located at:
    ``libc/test/src/stdbit/``, ``libc/test/include/stdbit_test.cpp``, and
    ``src/__support/CPP/bit_test.cpp``.

---------------------
Implementation Status
---------------------

Functions
=========

..
  Do not order these, they are as they appear in the standard.

============================ =========
Function Name                Available
============================ =========
stdc_leading_zeros_uc        |check|
stdc_leading_zeros_us        |check|
stdc_leading_zeros_ui        |check|
stdc_leading_zeros_ul        |check|
stdc_leading_zeros_ull       |check|
stdc_leading_ones_uc         |check|
stdc_leading_ones_us         |check|
stdc_leading_ones_ui         |check|
stdc_leading_ones_ul         |check|
stdc_leading_ones_ull        |check|
stdc_trailing_zeros_uc       |check|
stdc_trailing_zeros_us       |check|
stdc_trailing_zeros_ui       |check|
stdc_trailing_zeros_ul       |check|
stdc_trailing_zeros_ull      |check|
stdc_trailing_ones_uc        |check|
stdc_trailing_ones_us        |check|
stdc_trailing_ones_ui        |check|
stdc_trailing_ones_ul        |check|
stdc_trailing_ones_ull       |check|
stdc_first_leading_zero_uc   |check|
stdc_first_leading_zero_us   |check|
stdc_first_leading_zero_ui   |check|
stdc_first_leading_zero_ul   |check|
stdc_first_leading_zero_ull  |check|
stdc_first_leading_one_uc    |check|
stdc_first_leading_one_us    |check|
stdc_first_leading_one_ui    |check|
stdc_first_leading_one_ul    |check|
stdc_first_leading_one_ull   |check|
stdc_first_trailing_zero_uc  |check|
stdc_first_trailing_zero_us  |check|
stdc_first_trailing_zero_ui  |check|
stdc_first_trailing_zero_ul  |check|
stdc_first_trailing_zero_ull |check|
stdc_first_trailing_one_uc   |check|
stdc_first_trailing_one_us   |check|
stdc_first_trailing_one_ui   |check|
stdc_first_trailing_one_ul   |check|
stdc_first_trailing_one_ull  |check|
stdc_count_zeros_uc          |check|
stdc_count_zeros_us          |check|
stdc_count_zeros_ui          |check|
stdc_count_zeros_ul          |check|
stdc_count_zeros_ull         |check|
stdc_count_ones_uc           |check|
stdc_count_ones_us           |check|
stdc_count_ones_ui           |check|
stdc_count_ones_ul           |check|
stdc_count_ones_ull          |check|
stdc_has_single_bit_uc       |check|
stdc_has_single_bit_us       |check|
stdc_has_single_bit_ui       |check|
stdc_has_single_bit_ul       |check|
stdc_has_single_bit_ull      |check|
stdc_bit_width_uc            |check|
stdc_bit_width_us            |check|
stdc_bit_width_ui            |check|
stdc_bit_width_ul            |check|
stdc_bit_width_ull           |check|
stdc_bit_floor_uc            |check|
stdc_bit_floor_us            |check|
stdc_bit_floor_ui            |check|
stdc_bit_floor_ul            |check|
stdc_bit_floor_ull           |check|
stdc_bit_ceil_uc             |check|
stdc_bit_ceil_us             |check|
stdc_bit_ceil_ui             |check|
stdc_bit_ceil_ul             |check|
stdc_bit_ceil_ull            |check|
============================ =========


Macros
======

=========================  =========
Macro Name                 Available
=========================  =========
__STDC_VERSION_STDBIT_H__
__STDC_ENDIAN_LITTLE__
__STDC_ENDIAN_BIG__
__STDC_ENDIAN_NATIVE__
stdc_leading_zeros         |check|
stdc_leading_ones          |check|
stdc_trailing_zeros        |check|
stdc_trailing_ones         |check|
stdc_first_leading_zero    |check|
stdc_first_leading_one     |check|
stdc_first_trailing_zero   |check|
stdc_first_trailing_one    |check|
stdc_count_zeros           |check|
stdc_count_ones            |check|
stdc_has_single_bit        |check|
stdc_bit_width             |check|
stdc_bit_floor             |check|
stdc_bit_ceil              |check|
=========================  =========

Standards
=========
stdbit.h was specified as part of C23 in section 7.18 "Bit and byte utilities."