3 // Copyright (C) 2018-2020 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
26 * This is a Standard C++ Library header.
30 #define _GLIBCXX_BIT 1
32 #pragma GCC system_header
34 #if __cplusplus >= 201402L
36 #include <type_traits>
37 #include <bits/int_limits.h>
39 namespace std _GLIBCXX_VISIBILITY(default)
41 _GLIBCXX_BEGIN_NAMESPACE_VERSION
44 * @defgroup bit_manip Bit manipulation
47 * Utilities for examining and manipulating individual bits.
54 template<typename _Tp>
56 __rotl(_Tp __x, int __s) noexcept
58 constexpr auto _Nd = __detail::__int_limits<_Tp>::digits;
59 const int __r = __s % _Nd;
63 return (__x << __r) | (__x >> ((_Nd - __r) % _Nd));
65 return (__x >> -__r) | (__x << ((_Nd + __r) % _Nd)); // rotr(x, -r)
68 template<typename _Tp>
70 __rotr(_Tp __x, int __s) noexcept
72 constexpr auto _Nd = __detail::__int_limits<_Tp>::digits;
73 const int __r = __s % _Nd;
77 return (__x >> __r) | (__x << ((_Nd - __r) % _Nd));
79 return (__x << -__r) | (__x >> ((_Nd + __r) % _Nd)); // rotl(x, -r)
82 template<typename _Tp>
84 __countl_zero(_Tp __x) noexcept
86 using std::__detail::__int_limits;
87 constexpr auto _Nd = __int_limits<_Tp>::digits;
92 constexpr auto _Nd_ull = __int_limits<unsigned long long>::digits;
93 constexpr auto _Nd_ul = __int_limits<unsigned long>::digits;
94 constexpr auto _Nd_u = __int_limits<unsigned>::digits;
96 if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_u)
98 constexpr int __diff = _Nd_u - _Nd;
99 return __builtin_clz(__x) - __diff;
101 else if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_ul)
103 constexpr int __diff = _Nd_ul - _Nd;
104 return __builtin_clzl(__x) - __diff;
106 else if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_ull)
108 constexpr int __diff = _Nd_ull - _Nd;
109 return __builtin_clzll(__x) - __diff;
111 else // (_Nd > _Nd_ull)
113 static_assert(_Nd <= (2 * _Nd_ull),
114 "Maximum supported integer size is 128-bit");
116 unsigned long long __high = __x >> _Nd_ull;
119 constexpr int __diff = (2 * _Nd_ull) - _Nd;
120 return __builtin_clzll(__high) - __diff;
122 constexpr auto __max_ull = __int_limits<unsigned long long>::max();
123 unsigned long long __low = __x & __max_ull;
124 return (_Nd - _Nd_ull) + __builtin_clzll(__low);
128 template<typename _Tp>
130 __countl_one(_Tp __x) noexcept
132 if (__x == __detail::__int_limits<_Tp>::max())
133 return __detail::__int_limits<_Tp>::digits;
134 return std::__countl_zero<_Tp>((_Tp)~__x);
137 template<typename _Tp>
139 __countr_zero(_Tp __x) noexcept
141 using std::__detail::__int_limits;
142 constexpr auto _Nd = __int_limits<_Tp>::digits;
147 constexpr auto _Nd_ull = __int_limits<unsigned long long>::digits;
148 constexpr auto _Nd_ul = __int_limits<unsigned long>::digits;
149 constexpr auto _Nd_u = __int_limits<unsigned>::digits;
151 if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_u)
152 return __builtin_ctz(__x);
153 else if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_ul)
154 return __builtin_ctzl(__x);
155 else if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_ull)
156 return __builtin_ctzll(__x);
157 else // (_Nd > _Nd_ull)
159 static_assert(_Nd <= (2 * _Nd_ull),
160 "Maximum supported integer size is 128-bit");
162 constexpr auto __max_ull = __int_limits<unsigned long long>::max();
163 unsigned long long __low = __x & __max_ull;
165 return __builtin_ctzll(__low);
166 unsigned long long __high = __x >> _Nd_ull;
167 return __builtin_ctzll(__high) + _Nd_ull;
171 template<typename _Tp>
173 __countr_one(_Tp __x) noexcept
175 if (__x == __detail::__int_limits<_Tp>::max())
176 return __detail::__int_limits<_Tp>::digits;
177 return std::__countr_zero((_Tp)~__x);
180 template<typename _Tp>
182 __popcount(_Tp __x) noexcept
184 using std::__detail::__int_limits;
185 constexpr auto _Nd = __int_limits<_Tp>::digits;
190 constexpr auto _Nd_ull = __int_limits<unsigned long long>::digits;
191 constexpr auto _Nd_ul = __int_limits<unsigned long>::digits;
192 constexpr auto _Nd_u = __int_limits<unsigned>::digits;
194 if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_u)
195 return __builtin_popcount(__x);
196 else if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_ul)
197 return __builtin_popcountl(__x);
198 else if _GLIBCXX17_CONSTEXPR (_Nd <= _Nd_ull)
199 return __builtin_popcountll(__x);
200 else // (_Nd > _Nd_ull)
202 static_assert(_Nd <= (2 * _Nd_ull),
203 "Maximum supported integer size is 128-bit");
205 constexpr auto __max_ull = __int_limits<unsigned long long>::max();
206 unsigned long long __low = __x & __max_ull;
207 unsigned long long __high = __x >> _Nd_ull;
208 return __builtin_popcountll(__low) + __builtin_popcountll(__high);
212 template<typename _Tp>
214 __has_single_bit(_Tp __x) noexcept
215 { return std::__popcount(__x) == 1; }
217 template<typename _Tp>
219 __bit_ceil(_Tp __x) noexcept
221 using std::__detail::__int_limits;
222 constexpr auto _Nd = __int_limits<_Tp>::digits;
223 if (__x == 0 || __x == 1)
225 auto __shift_exponent = _Nd - std::__countl_zero((_Tp)(__x - 1u));
226 // If the shift exponent equals _Nd then the correct result is not
227 // representable as a value of _Tp, and so the result is undefined.
228 // Want that undefined behaviour to be detected in constant expressions,
229 // by UBSan, and by debug assertions.
230 #ifdef _GLIBCXX_HAVE_BUILTIN_IS_CONSTANT_EVALUATED
231 if (!__builtin_is_constant_evaluated())
233 __glibcxx_assert( __shift_exponent != __int_limits<_Tp>::digits );
236 using __promoted_type = decltype(__x << 1);
237 if _GLIBCXX17_CONSTEXPR (!is_same<__promoted_type, _Tp>::value)
239 // If __x undergoes integral promotion then shifting by _Nd is
240 // not undefined. In order to make the shift undefined, so that
241 // it is diagnosed in constant expressions and by UBsan, we also
242 // need to "promote" the shift exponent to be too large for the
244 const int __extra_exp = sizeof(__promoted_type) / sizeof(_Tp) / 2;
245 __shift_exponent |= (__shift_exponent & _Nd) << __extra_exp;
247 return (_Tp)1u << __shift_exponent;
250 template<typename _Tp>
252 __bit_floor(_Tp __x) noexcept
254 constexpr auto _Nd = __detail::__int_limits<_Tp>::digits;
257 return (_Tp)1u << (_Nd - std::__countl_zero((_Tp)(__x >> 1)));
260 template<typename _Tp>
262 __bit_width(_Tp __x) noexcept
264 constexpr auto _Nd = __detail::__int_limits<_Tp>::digits;
265 return _Nd - std::__countl_zero(__x);
270 #if __cplusplus > 201703L
272 #define __cpp_lib_bitops 201907L
275 template<typename _Tp, typename _Up = _Tp>
276 using _If_is_unsigned_integer
277 = enable_if_t<__is_unsigned_integer<_Tp>::value, _Up>;
280 // [bit.rot], rotating
282 /// Rotate `x` to the left by `s` bits.
283 template<typename _Tp>
284 [[nodiscard]] constexpr _If_is_unsigned_integer<_Tp>
285 rotl(_Tp __x, int __s) noexcept
286 { return std::__rotl(__x, __s); }
288 /// Rotate `x` to the right by `s` bits.
289 template<typename _Tp>
290 [[nodiscard]] constexpr _If_is_unsigned_integer<_Tp>
291 rotr(_Tp __x, int __s) noexcept
292 { return std::__rotr(__x, __s); }
294 // [bit.count], counting
296 /// The number of contiguous zero bits, starting from the highest bit.
297 template<typename _Tp>
298 constexpr _If_is_unsigned_integer<_Tp, int>
299 countl_zero(_Tp __x) noexcept
300 { return std::__countl_zero(__x); }
302 /// The number of contiguous one bits, starting from the highest bit.
303 template<typename _Tp>
304 constexpr _If_is_unsigned_integer<_Tp, int>
305 countl_one(_Tp __x) noexcept
306 { return std::__countl_one(__x); }
308 /// The number of contiguous zero bits, starting from the lowest bit.
309 template<typename _Tp>
310 constexpr _If_is_unsigned_integer<_Tp, int>
311 countr_zero(_Tp __x) noexcept
312 { return std::__countr_zero(__x); }
314 /// The number of contiguous one bits, starting from the lowest bit.
315 template<typename _Tp>
316 constexpr _If_is_unsigned_integer<_Tp, int>
317 countr_one(_Tp __x) noexcept
318 { return std::__countr_one(__x); }
320 /// The number of bits set in `x`.
321 template<typename _Tp>
322 constexpr _If_is_unsigned_integer<_Tp, int>
323 popcount(_Tp __x) noexcept
324 { return std::__popcount(__x); }
326 // [bit.pow.two], integral powers of 2
328 #define __cpp_lib_int_pow2 202002L
330 /// True if `x` is a power of two, false otherwise.
331 template<typename _Tp>
332 constexpr _If_is_unsigned_integer<_Tp, bool>
333 has_single_bit(_Tp __x) noexcept
334 { return std::__has_single_bit(__x); }
336 /// The smallest power-of-two not less than `x`.
337 template<typename _Tp>
338 constexpr _If_is_unsigned_integer<_Tp>
339 bit_ceil(_Tp __x) noexcept
340 { return std::__bit_ceil(__x); }
342 /// The largest power-of-two not greater than `x`.
343 template<typename _Tp>
344 constexpr _If_is_unsigned_integer<_Tp>
345 bit_floor(_Tp __x) noexcept
346 { return std::__bit_floor(__x); }
348 /// The smallest integer greater than the base-2 logarithm of `x`.
349 template<typename _Tp>
350 constexpr _If_is_unsigned_integer<_Tp>
351 bit_width(_Tp __x) noexcept
352 { return std::__bit_width(__x); }
354 #define __cpp_lib_endian 201907L
359 little = __ORDER_LITTLE_ENDIAN__,
360 big = __ORDER_BIG_ENDIAN__,
361 native = __BYTE_ORDER__
367 _GLIBCXX_END_NAMESPACE_VERSION
371 #endif // _GLIBCXX_BIT