3// Copyright (C) 2001-2022 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/>.
27 * Silicon Graphics Computer Systems, Inc.
29 * Permission to use, copy, modify, distribute and sell this software
30 * and its documentation for any purpose is hereby granted without fee,
31 * provided that the above copyright notice appear in all copies and
32 * that both that copyright notice and this permission notice appear
33 * in supporting documentation. Silicon Graphics makes no
34 * representations about the suitability of this software for any
35 * purpose. It is provided "as is" without express or implied warranty.
38/** @file include/bitset
39 * This is a Standard C++ Library header.
42#ifndef _GLIBCXX_BITSET
43#define _GLIBCXX_BITSET 1
45#pragma GCC system_header
48#include <bits/functexcept.h> // For invalid_argument, out_of_range,
51#include <bits/cxxabi_forced.h>
53#if __cplusplus >= 201103L
54# include <bits/functional_hash.h>
57#define _GLIBCXX_BITSET_BITS_PER_WORD (__CHAR_BIT__ * __SIZEOF_LONG__)
58#define _GLIBCXX_BITSET_WORDS(__n) \
59 ((__n) / _GLIBCXX_BITSET_BITS_PER_WORD + \
60 ((__n) % _GLIBCXX_BITSET_BITS_PER_WORD == 0 ? 0 : 1))
62#define _GLIBCXX_BITSET_BITS_PER_ULL (__CHAR_BIT__ * __SIZEOF_LONG_LONG__)
64namespace std _GLIBCXX_VISIBILITY(default)
66_GLIBCXX_BEGIN_NAMESPACE_CONTAINER
69 * Base class, general case. It is a class invariant that _Nw will be
72 * See documentation for bitset.
77 typedef unsigned long _WordT;
79 /// 0 is the least significant word.
82 _GLIBCXX_CONSTEXPR _Base_bitset() _GLIBCXX_NOEXCEPT
85#if __cplusplus >= 201103L
86 constexpr _Base_bitset(unsigned long long __val) noexcept
88#if __SIZEOF_LONG_LONG__ > __SIZEOF_LONG__
89 , _WordT(__val >> _GLIBCXX_BITSET_BITS_PER_WORD)
93 _Base_bitset(unsigned long __val)
98 static _GLIBCXX_CONSTEXPR size_t
99 _S_whichword(size_t __pos) _GLIBCXX_NOEXCEPT
100 { return __pos / _GLIBCXX_BITSET_BITS_PER_WORD; }
102 static _GLIBCXX_CONSTEXPR size_t
103 _S_whichbyte(size_t __pos) _GLIBCXX_NOEXCEPT
104 { return (__pos % _GLIBCXX_BITSET_BITS_PER_WORD) / __CHAR_BIT__; }
106 static _GLIBCXX_CONSTEXPR size_t
107 _S_whichbit(size_t __pos) _GLIBCXX_NOEXCEPT
108 { return __pos % _GLIBCXX_BITSET_BITS_PER_WORD; }
110 static _GLIBCXX_CONSTEXPR _WordT
111 _S_maskbit(size_t __pos) _GLIBCXX_NOEXCEPT
112 { return (static_cast<_WordT>(1)) << _S_whichbit(__pos); }
115 _M_getword(size_t __pos) _GLIBCXX_NOEXCEPT
116 { return _M_w[_S_whichword(__pos)]; }
118 _GLIBCXX_CONSTEXPR _WordT
119 _M_getword(size_t __pos) const _GLIBCXX_NOEXCEPT
120 { return _M_w[_S_whichword(__pos)]; }
122#if __cplusplus >= 201103L
124 _M_getdata() const noexcept
129 _M_hiword() _GLIBCXX_NOEXCEPT
130 { return _M_w[_Nw - 1]; }
132 _GLIBCXX_CONSTEXPR _WordT
133 _M_hiword() const _GLIBCXX_NOEXCEPT
134 { return _M_w[_Nw - 1]; }
137 _M_do_and(const _Base_bitset<_Nw>& __x) _GLIBCXX_NOEXCEPT
139 for (size_t __i = 0; __i < _Nw; __i++)
140 _M_w[__i] &= __x._M_w[__i];
144 _M_do_or(const _Base_bitset<_Nw>& __x) _GLIBCXX_NOEXCEPT
146 for (size_t __i = 0; __i < _Nw; __i++)
147 _M_w[__i] |= __x._M_w[__i];
151 _M_do_xor(const _Base_bitset<_Nw>& __x) _GLIBCXX_NOEXCEPT
153 for (size_t __i = 0; __i < _Nw; __i++)
154 _M_w[__i] ^= __x._M_w[__i];
158 _M_do_left_shift(size_t __shift) _GLIBCXX_NOEXCEPT;
161 _M_do_right_shift(size_t __shift) _GLIBCXX_NOEXCEPT;
164 _M_do_flip() _GLIBCXX_NOEXCEPT
166 for (size_t __i = 0; __i < _Nw; __i++)
167 _M_w[__i] = ~_M_w[__i];
171 _M_do_set() _GLIBCXX_NOEXCEPT
173 for (size_t __i = 0; __i < _Nw; __i++)
174 _M_w[__i] = ~static_cast<_WordT>(0);
178 _M_do_reset() _GLIBCXX_NOEXCEPT
179 { __builtin_memset(_M_w, 0, _Nw * sizeof(_WordT)); }
182 _M_is_equal(const _Base_bitset<_Nw>& __x) const _GLIBCXX_NOEXCEPT
184 for (size_t __i = 0; __i < _Nw; ++__i)
185 if (_M_w[__i] != __x._M_w[__i])
192 _M_are_all() const _GLIBCXX_NOEXCEPT
194 for (size_t __i = 0; __i < _Nw - 1; __i++)
195 if (_M_w[__i] != ~static_cast<_WordT>(0))
197 return _M_hiword() == (~static_cast<_WordT>(0)
198 >> (_Nw * _GLIBCXX_BITSET_BITS_PER_WORD
203 _M_is_any() const _GLIBCXX_NOEXCEPT
205 for (size_t __i = 0; __i < _Nw; __i++)
206 if (_M_w[__i] != static_cast<_WordT>(0))
212 _M_do_count() const _GLIBCXX_NOEXCEPT
215 for (size_t __i = 0; __i < _Nw; __i++)
216 __result += __builtin_popcountl(_M_w[__i]);
221 _M_do_to_ulong() const;
223#if __cplusplus >= 201103L
225 _M_do_to_ullong() const;
228 // find first "on" bit
230 _M_do_find_first(size_t) const _GLIBCXX_NOEXCEPT;
232 // find the next "on" bit that follows "prev"
234 _M_do_find_next(size_t, size_t) const _GLIBCXX_NOEXCEPT;
237 // Definitions of non-inline functions from _Base_bitset.
240 _Base_bitset<_Nw>::_M_do_left_shift(size_t __shift) _GLIBCXX_NOEXCEPT
242 if (__builtin_expect(__shift != 0, 1))
244 const size_t __wshift = __shift / _GLIBCXX_BITSET_BITS_PER_WORD;
245 const size_t __offset = __shift % _GLIBCXX_BITSET_BITS_PER_WORD;
248 for (size_t __n = _Nw - 1; __n >= __wshift; --__n)
249 _M_w[__n] = _M_w[__n - __wshift];
252 const size_t __sub_offset = (_GLIBCXX_BITSET_BITS_PER_WORD
254 for (size_t __n = _Nw - 1; __n > __wshift; --__n)
255 _M_w[__n] = ((_M_w[__n - __wshift] << __offset)
256 | (_M_w[__n - __wshift - 1] >> __sub_offset));
257 _M_w[__wshift] = _M_w[0] << __offset;
260 std::fill(_M_w + 0, _M_w + __wshift, static_cast<_WordT>(0));
266 _Base_bitset<_Nw>::_M_do_right_shift(size_t __shift) _GLIBCXX_NOEXCEPT
268 if (__builtin_expect(__shift != 0, 1))
270 const size_t __wshift = __shift / _GLIBCXX_BITSET_BITS_PER_WORD;
271 const size_t __offset = __shift % _GLIBCXX_BITSET_BITS_PER_WORD;
272 const size_t __limit = _Nw - __wshift - 1;
275 for (size_t __n = 0; __n <= __limit; ++__n)
276 _M_w[__n] = _M_w[__n + __wshift];
279 const size_t __sub_offset = (_GLIBCXX_BITSET_BITS_PER_WORD
281 for (size_t __n = 0; __n < __limit; ++__n)
282 _M_w[__n] = ((_M_w[__n + __wshift] >> __offset)
283 | (_M_w[__n + __wshift + 1] << __sub_offset));
284 _M_w[__limit] = _M_w[_Nw-1] >> __offset;
287 std::fill(_M_w + __limit + 1, _M_w + _Nw, static_cast<_WordT>(0));
293 _Base_bitset<_Nw>::_M_do_to_ulong() const
295 for (size_t __i = 1; __i < _Nw; ++__i)
297 __throw_overflow_error(__N("_Base_bitset::_M_do_to_ulong"));
301#if __cplusplus >= 201103L
304 _Base_bitset<_Nw>::_M_do_to_ullong() const
306 const bool __dw = sizeof(unsigned long long) > sizeof(unsigned long);
307 for (size_t __i = 1 + __dw; __i < _Nw; ++__i)
309 __throw_overflow_error(__N("_Base_bitset::_M_do_to_ullong"));
312 return _M_w[0] + (static_cast<unsigned long long>(_M_w[1])
313 << _GLIBCXX_BITSET_BITS_PER_WORD);
321 _M_do_find_first(size_t __not_found) const _GLIBCXX_NOEXCEPT
323 for (size_t __i = 0; __i < _Nw; __i++)
325 _WordT __thisword = _M_w[__i];
326 if (__thisword != static_cast<_WordT>(0))
327 return (__i * _GLIBCXX_BITSET_BITS_PER_WORD
328 + __builtin_ctzl(__thisword));
330 // not found, so return an indication of failure.
337 _M_do_find_next(size_t __prev, size_t __not_found) const _GLIBCXX_NOEXCEPT
339 // make bound inclusive
342 // check out of bounds
343 if (__prev >= _Nw * _GLIBCXX_BITSET_BITS_PER_WORD)
347 size_t __i = _S_whichword(__prev);
348 _WordT __thisword = _M_w[__i];
350 // mask off bits below bound
351 __thisword &= (~static_cast<_WordT>(0)) << _S_whichbit(__prev);
353 if (__thisword != static_cast<_WordT>(0))
354 return (__i * _GLIBCXX_BITSET_BITS_PER_WORD
355 + __builtin_ctzl(__thisword));
357 // check subsequent words
359 for (; __i < _Nw; __i++)
361 __thisword = _M_w[__i];
362 if (__thisword != static_cast<_WordT>(0))
363 return (__i * _GLIBCXX_BITSET_BITS_PER_WORD
364 + __builtin_ctzl(__thisword));
366 // not found, so return an indication of failure.
368 } // end _M_do_find_next
371 * Base class, specialization for a single word.
373 * See documentation for bitset.
376 struct _Base_bitset<1>
378 typedef unsigned long _WordT;
381 _GLIBCXX_CONSTEXPR _Base_bitset() _GLIBCXX_NOEXCEPT
385#if __cplusplus >= 201103L
386 constexpr _Base_bitset(unsigned long long __val) noexcept
388 _Base_bitset(unsigned long __val)
393 static _GLIBCXX_CONSTEXPR size_t
394 _S_whichword(size_t __pos) _GLIBCXX_NOEXCEPT
395 { return __pos / _GLIBCXX_BITSET_BITS_PER_WORD; }
397 static _GLIBCXX_CONSTEXPR size_t
398 _S_whichbyte(size_t __pos) _GLIBCXX_NOEXCEPT
399 { return (__pos % _GLIBCXX_BITSET_BITS_PER_WORD) / __CHAR_BIT__; }
401 static _GLIBCXX_CONSTEXPR size_t
402 _S_whichbit(size_t __pos) _GLIBCXX_NOEXCEPT
403 { return __pos % _GLIBCXX_BITSET_BITS_PER_WORD; }
405 static _GLIBCXX_CONSTEXPR _WordT
406 _S_maskbit(size_t __pos) _GLIBCXX_NOEXCEPT
407 { return (static_cast<_WordT>(1)) << _S_whichbit(__pos); }
410 _M_getword(size_t) _GLIBCXX_NOEXCEPT
413 _GLIBCXX_CONSTEXPR _WordT
414 _M_getword(size_t) const _GLIBCXX_NOEXCEPT
417#if __cplusplus >= 201103L
419 _M_getdata() const noexcept
424 _M_hiword() _GLIBCXX_NOEXCEPT
427 _GLIBCXX_CONSTEXPR _WordT
428 _M_hiword() const _GLIBCXX_NOEXCEPT
432 _M_do_and(const _Base_bitset<1>& __x) _GLIBCXX_NOEXCEPT
433 { _M_w &= __x._M_w; }
436 _M_do_or(const _Base_bitset<1>& __x) _GLIBCXX_NOEXCEPT
437 { _M_w |= __x._M_w; }
440 _M_do_xor(const _Base_bitset<1>& __x) _GLIBCXX_NOEXCEPT
441 { _M_w ^= __x._M_w; }
444 _M_do_left_shift(size_t __shift) _GLIBCXX_NOEXCEPT
445 { _M_w <<= __shift; }
448 _M_do_right_shift(size_t __shift) _GLIBCXX_NOEXCEPT
449 { _M_w >>= __shift; }
452 _M_do_flip() _GLIBCXX_NOEXCEPT
456 _M_do_set() _GLIBCXX_NOEXCEPT
457 { _M_w = ~static_cast<_WordT>(0); }
460 _M_do_reset() _GLIBCXX_NOEXCEPT
464 _M_is_equal(const _Base_bitset<1>& __x) const _GLIBCXX_NOEXCEPT
465 { return _M_w == __x._M_w; }
469 _M_are_all() const _GLIBCXX_NOEXCEPT
470 { return _M_w == (~static_cast<_WordT>(0)
471 >> (_GLIBCXX_BITSET_BITS_PER_WORD - _Nb)); }
474 _M_is_any() const _GLIBCXX_NOEXCEPT
475 { return _M_w != 0; }
478 _M_do_count() const _GLIBCXX_NOEXCEPT
479 { return __builtin_popcountl(_M_w); }
482 _M_do_to_ulong() const _GLIBCXX_NOEXCEPT
485#if __cplusplus >= 201103L
487 _M_do_to_ullong() const noexcept
492 _M_do_find_first(size_t __not_found) const _GLIBCXX_NOEXCEPT
495 return __builtin_ctzl(_M_w);
500 // find the next "on" bit that follows "prev"
502 _M_do_find_next(size_t __prev, size_t __not_found) const
506 if (__prev >= ((size_t) _GLIBCXX_BITSET_BITS_PER_WORD))
509 _WordT __x = _M_w >> __prev;
511 return __builtin_ctzl(__x) + __prev;
518 * Base class, specialization for no storage (zero-length %bitset).
520 * See documentation for bitset.
523 struct _Base_bitset<0>
525 typedef unsigned long _WordT;
527 _GLIBCXX_CONSTEXPR _Base_bitset() _GLIBCXX_NOEXCEPT
530#if __cplusplus >= 201103L
531 constexpr _Base_bitset(unsigned long long) noexcept
533 _Base_bitset(unsigned long)
537 static _GLIBCXX_CONSTEXPR size_t
538 _S_whichword(size_t __pos) _GLIBCXX_NOEXCEPT
539 { return __pos / _GLIBCXX_BITSET_BITS_PER_WORD; }
541 static _GLIBCXX_CONSTEXPR size_t
542 _S_whichbyte(size_t __pos) _GLIBCXX_NOEXCEPT
543 { return (__pos % _GLIBCXX_BITSET_BITS_PER_WORD) / __CHAR_BIT__; }
545 static _GLIBCXX_CONSTEXPR size_t
546 _S_whichbit(size_t __pos) _GLIBCXX_NOEXCEPT
547 { return __pos % _GLIBCXX_BITSET_BITS_PER_WORD; }
549 static _GLIBCXX_CONSTEXPR _WordT
550 _S_maskbit(size_t __pos) _GLIBCXX_NOEXCEPT
551 { return (static_cast<_WordT>(1)) << _S_whichbit(__pos); }
553 // This would normally give access to the data. The bounds-checking
554 // in the bitset class will prevent the user from getting this far,
555 // but (1) it must still return an lvalue to compile, and (2) the
556 // user might call _Unchecked_set directly, in which case this /needs/
557 // to fail. Let's not penalize zero-length users unless they actually
558 // make an unchecked call; all the memory ugliness is therefore
559 // localized to this single should-never-get-this-far function.
561 _M_getword(size_t) _GLIBCXX_NOEXCEPT
563 __throw_out_of_range(__N("_Base_bitset::_M_getword"));
567 _GLIBCXX_CONSTEXPR _WordT
568 _M_getword(size_t) const _GLIBCXX_NOEXCEPT
571 _GLIBCXX_CONSTEXPR _WordT
572 _M_hiword() const _GLIBCXX_NOEXCEPT
576 _M_do_and(const _Base_bitset<0>&) _GLIBCXX_NOEXCEPT
580 _M_do_or(const _Base_bitset<0>&) _GLIBCXX_NOEXCEPT
584 _M_do_xor(const _Base_bitset<0>&) _GLIBCXX_NOEXCEPT
588 _M_do_left_shift(size_t) _GLIBCXX_NOEXCEPT
592 _M_do_right_shift(size_t) _GLIBCXX_NOEXCEPT
596 _M_do_flip() _GLIBCXX_NOEXCEPT
600 _M_do_set() _GLIBCXX_NOEXCEPT
604 _M_do_reset() _GLIBCXX_NOEXCEPT
607 // Are all empty bitsets equal to each other? Are they equal to
608 // themselves? How to compare a thing which has no state? What is
609 // the sound of one zero-length bitset clapping?
611 _M_is_equal(const _Base_bitset<0>&) const _GLIBCXX_NOEXCEPT
616 _M_are_all() const _GLIBCXX_NOEXCEPT
620 _M_is_any() const _GLIBCXX_NOEXCEPT
624 _M_do_count() const _GLIBCXX_NOEXCEPT
628 _M_do_to_ulong() const _GLIBCXX_NOEXCEPT
631#if __cplusplus >= 201103L
633 _M_do_to_ullong() const noexcept
637 // Normally "not found" is the size, but that could also be
638 // misinterpreted as an index in this corner case. Oh well.
640 _M_do_find_first(size_t) const _GLIBCXX_NOEXCEPT
644 _M_do_find_next(size_t, size_t) const _GLIBCXX_NOEXCEPT
649 // Helper class to zero out the unused high-order bits in the highest word.
650 template<size_t _Extrabits>
653 typedef unsigned long _WordT;
656 _S_do_sanitize(_WordT& __val) _GLIBCXX_NOEXCEPT
657 { __val &= ~((~static_cast<_WordT>(0)) << _Extrabits); }
663 typedef unsigned long _WordT;
666 _S_do_sanitize(_WordT) _GLIBCXX_NOEXCEPT { }
669#if __cplusplus >= 201103L
670 template<size_t _Nb, bool = (_Nb < _GLIBCXX_BITSET_BITS_PER_ULL)>
673 static constexpr unsigned long long
674 _S_do_sanitize_val(unsigned long long __val)
679 struct _Sanitize_val<_Nb, true>
681 static constexpr unsigned long long
682 _S_do_sanitize_val(unsigned long long __val)
683 { return __val & ~((~static_cast<unsigned long long>(0)) << _Nb); }
688 * @brief The %bitset class represents a @e fixed-size sequence of bits.
691 * (Note that %bitset does @e not meet the formal requirements of a
692 * <a href="tables.html#65">container</a>. Mainly, it lacks iterators.)
694 * The template argument, @a Nb, may be any non-negative number,
695 * specifying the number of bits (e.g., "0", "12", "1024*1024").
697 * In the general unoptimized case, storage is allocated in word-sized
698 * blocks. Let B be the number of bits in a word, then (Nb+(B-1))/B
699 * words will be used for storage. B - Nb%B bits are unused. (They are
700 * the high-order bits in the highest word.) It is a class invariant
701 * that those unused bits are always zero.
703 * If you think of %bitset as <em>a simple array of bits</em>, be
704 * aware that your mental picture is reversed: a %bitset behaves
705 * the same way as bits in integers do, with the bit at index 0 in
706 * the <em>least significant / right-hand</em> position, and the bit at
707 * index Nb-1 in the <em>most significant / left-hand</em> position.
708 * Thus, unlike other containers, a %bitset's index <em>counts from
709 * right to left</em>, to put it very loosely.
711 * This behavior is preserved when translating to and from strings. For
712 * example, the first line of the following program probably prints
713 * <em>b('a') is 0001100001</em> on a modern ASCII system.
717 * #include <iostream>
720 * using namespace std;
727 * cout << "b('a') is " << b << endl;
731 * string str = s.str();
732 * cout << "index 3 in the string is " << str[3] << " but\n"
733 * << "index 3 in the bitset is " << b[3] << endl;
738 * https://gcc.gnu.org/onlinedocs/libstdc++/manual/ext_containers.html
739 * for a description of extensions.
741 * Most of the actual code isn't contained in %bitset<> itself, but in the
742 * base class _Base_bitset. The base class works with whole words, not with
743 * individual bits. This allows us to specialize _Base_bitset for the
744 * important special case where the %bitset is only a single word.
746 * Extra confusion can result due to the fact that the storage for
747 * _Base_bitset @e is a regular array, and is indexed as such. This is
748 * carefully encapsulated.
752 : private _Base_bitset<_GLIBCXX_BITSET_WORDS(_Nb)>
755 typedef _Base_bitset<_GLIBCXX_BITSET_WORDS(_Nb)> _Base;
756 typedef unsigned long _WordT;
758 template<class _CharT, class _Traits, class _Alloc>
760 _M_check_initial_position(const std::basic_string<_CharT, _Traits, _Alloc>& __s,
761 size_t __position) const
763 if (__position > __s.size())
764 __throw_out_of_range_fmt(__N("bitset::bitset: __position "
765 "(which is %zu) > __s.size() "
767 __position, __s.size());
770 void _M_check(size_t __position, const char *__s) const
772 if (__position >= _Nb)
773 __throw_out_of_range_fmt(__N("%s: __position (which is %zu) "
774 ">= _Nb (which is %zu)"),
775 __s, __position, _Nb);
779 _M_do_sanitize() _GLIBCXX_NOEXCEPT
781 typedef _Sanitize<_Nb % _GLIBCXX_BITSET_BITS_PER_WORD> __sanitize_type;
782 __sanitize_type::_S_do_sanitize(this->_M_hiword());
785#if __cplusplus >= 201103L
786 friend struct std::hash<bitset>;
791 * This encapsulates the concept of a single bit. An instance of this
792 * class is a proxy for an actual bit; this way the individual bit
793 * operations are done as faster word-size bitwise instructions.
795 * Most users will never need to use this class directly; conversions
796 * to and from bool are automatic and should be transparent. Overloaded
797 * operators help to preserve the illusion.
799 * (On a typical system, this <em>bit %reference</em> is 64
800 * times the size of an actual bit. Ha.)
813 reference(bitset& __b, size_t __pos) _GLIBCXX_NOEXCEPT
815 _M_wp = &__b._M_getword(__pos);
816 _M_bpos = _Base::_S_whichbit(__pos);
819#if __cplusplus >= 201103L
820 reference(const reference&) = default;
823 ~reference() _GLIBCXX_NOEXCEPT
828 operator=(bool __x) _GLIBCXX_NOEXCEPT
831 *_M_wp |= _Base::_S_maskbit(_M_bpos);
833 *_M_wp &= ~_Base::_S_maskbit(_M_bpos);
837 // For b[i] = b[__j];
839 operator=(const reference& __j) _GLIBCXX_NOEXCEPT
841 if ((*(__j._M_wp) & _Base::_S_maskbit(__j._M_bpos)))
842 *_M_wp |= _Base::_S_maskbit(_M_bpos);
844 *_M_wp &= ~_Base::_S_maskbit(_M_bpos);
850 operator~() const _GLIBCXX_NOEXCEPT
851 { return (*(_M_wp) & _Base::_S_maskbit(_M_bpos)) == 0; }
854 operator bool() const _GLIBCXX_NOEXCEPT
855 { return (*(_M_wp) & _Base::_S_maskbit(_M_bpos)) != 0; }
859 flip() _GLIBCXX_NOEXCEPT
861 *_M_wp ^= _Base::_S_maskbit(_M_bpos);
865 friend class reference;
867 // 23.3.5.1 constructors:
868 /// All bits set to zero.
869 _GLIBCXX_CONSTEXPR bitset() _GLIBCXX_NOEXCEPT
872 /// Initial bits bitwise-copied from a single word (others set to zero).
873#if __cplusplus >= 201103L
874 constexpr bitset(unsigned long long __val) noexcept
875 : _Base(_Sanitize_val<_Nb>::_S_do_sanitize_val(__val)) { }
877 bitset(unsigned long __val)
879 { _M_do_sanitize(); }
883 * Use a subset of a string.
884 * @param __s A string of @a 0 and @a 1 characters.
885 * @param __position Index of the first character in @a __s to use;
887 * @throw std::out_of_range If @a pos is bigger the size of @a __s.
888 * @throw std::invalid_argument If a character appears in the string
889 * which is neither @a 0 nor @a 1.
891 template<class _CharT, class _Traits, class _Alloc>
893 bitset(const std::basic_string<_CharT, _Traits, _Alloc>& __s,
894 size_t __position = 0)
897 _M_check_initial_position(__s, __position);
898 _M_copy_from_string(__s, __position,
899 std::basic_string<_CharT, _Traits, _Alloc>::npos,
900 _CharT('0'), _CharT('1'));
904 * Use a subset of a string.
905 * @param __s A string of @a 0 and @a 1 characters.
906 * @param __position Index of the first character in @a __s to use.
907 * @param __n The number of characters to copy.
908 * @throw std::out_of_range If @a __position is bigger the size
910 * @throw std::invalid_argument If a character appears in the string
911 * which is neither @a 0 nor @a 1.
913 template<class _CharT, class _Traits, class _Alloc>
914 bitset(const std::basic_string<_CharT, _Traits, _Alloc>& __s,
915 size_t __position, size_t __n)
918 _M_check_initial_position(__s, __position);
919 _M_copy_from_string(__s, __position, __n, _CharT('0'), _CharT('1'));
922 // _GLIBCXX_RESOLVE_LIB_DEFECTS
923 // 396. what are characters zero and one.
924 template<class _CharT, class _Traits, class _Alloc>
925 bitset(const std::basic_string<_CharT, _Traits, _Alloc>& __s,
926 size_t __position, size_t __n,
927 _CharT __zero, _CharT __one = _CharT('1'))
930 _M_check_initial_position(__s, __position);
931 _M_copy_from_string(__s, __position, __n, __zero, __one);
934#if __cplusplus >= 201103L
936 * Construct from a character %array.
937 * @param __str An %array of characters @a zero and @a one.
938 * @param __n The number of characters to use.
939 * @param __zero The character corresponding to the value 0.
940 * @param __one The character corresponding to the value 1.
941 * @throw std::invalid_argument If a character appears in the string
942 * which is neither @a __zero nor @a __one.
944 template<typename _CharT>
946 bitset(const _CharT* __str,
947 typename std::basic_string<_CharT>::size_type __n
948 = std::basic_string<_CharT>::npos,
949 _CharT __zero = _CharT('0'), _CharT __one = _CharT('1'))
953 __throw_logic_error(__N("bitset::bitset(const _CharT*, ...)"));
955 if (__n == std::basic_string<_CharT>::npos)
956 __n = std::char_traits<_CharT>::length(__str);
957 _M_copy_from_ptr<_CharT, std::char_traits<_CharT>>(__str, __n, 0,
963 // 23.3.5.2 bitset operations:
966 * Operations on bitsets.
967 * @param __rhs A same-sized bitset.
969 * These should be self-explanatory.
972 operator&=(const bitset<_Nb>& __rhs) _GLIBCXX_NOEXCEPT
974 this->_M_do_and(__rhs);
979 operator|=(const bitset<_Nb>& __rhs) _GLIBCXX_NOEXCEPT
981 this->_M_do_or(__rhs);
986 operator^=(const bitset<_Nb>& __rhs) _GLIBCXX_NOEXCEPT
988 this->_M_do_xor(__rhs);
995 * Operations on bitsets.
996 * @param __position The number of places to shift.
998 * These should be self-explanatory.
1001 operator<<=(size_t __position) _GLIBCXX_NOEXCEPT
1003 if (__builtin_expect(__position < _Nb, 1))
1005 this->_M_do_left_shift(__position);
1006 this->_M_do_sanitize();
1009 this->_M_do_reset();
1014 operator>>=(size_t __position) _GLIBCXX_NOEXCEPT
1016 if (__builtin_expect(__position < _Nb, 1))
1018 this->_M_do_right_shift(__position);
1019 this->_M_do_sanitize();
1022 this->_M_do_reset();
1029 * These versions of single-bit set, reset, flip, and test are
1030 * extensions from the SGI version. They do no range checking.
1031 * @ingroup SGIextensions
1034 _Unchecked_set(size_t __pos) _GLIBCXX_NOEXCEPT
1036 this->_M_getword(__pos) |= _Base::_S_maskbit(__pos);
1041 _Unchecked_set(size_t __pos, int __val) _GLIBCXX_NOEXCEPT
1044 this->_M_getword(__pos) |= _Base::_S_maskbit(__pos);
1046 this->_M_getword(__pos) &= ~_Base::_S_maskbit(__pos);
1051 _Unchecked_reset(size_t __pos) _GLIBCXX_NOEXCEPT
1053 this->_M_getword(__pos) &= ~_Base::_S_maskbit(__pos);
1058 _Unchecked_flip(size_t __pos) _GLIBCXX_NOEXCEPT
1060 this->_M_getword(__pos) ^= _Base::_S_maskbit(__pos);
1064 _GLIBCXX_CONSTEXPR bool
1065 _Unchecked_test(size_t __pos) const _GLIBCXX_NOEXCEPT
1066 { return ((this->_M_getword(__pos) & _Base::_S_maskbit(__pos))
1067 != static_cast<_WordT>(0)); }
1070 // Set, reset, and flip.
1072 * @brief Sets every bit to true.
1075 set() _GLIBCXX_NOEXCEPT
1078 this->_M_do_sanitize();
1083 * @brief Sets a given bit to a particular value.
1084 * @param __position The index of the bit.
1085 * @param __val Either true or false, defaults to true.
1086 * @throw std::out_of_range If @a pos is bigger the size of the %set.
1089 set(size_t __position, bool __val = true)
1091 this->_M_check(__position, __N("bitset::set"));
1092 return _Unchecked_set(__position, __val);
1096 * @brief Sets every bit to false.
1099 reset() _GLIBCXX_NOEXCEPT
1101 this->_M_do_reset();
1106 * @brief Sets a given bit to false.
1107 * @param __position The index of the bit.
1108 * @throw std::out_of_range If @a pos is bigger the size of the %set.
1110 * Same as writing @c set(pos,false).
1113 reset(size_t __position)
1115 this->_M_check(__position, __N("bitset::reset"));
1116 return _Unchecked_reset(__position);
1120 * @brief Toggles every bit to its opposite value.
1123 flip() _GLIBCXX_NOEXCEPT
1126 this->_M_do_sanitize();
1131 * @brief Toggles a given bit to its opposite value.
1132 * @param __position The index of the bit.
1133 * @throw std::out_of_range If @a pos is bigger the size of the %set.
1136 flip(size_t __position)
1138 this->_M_check(__position, __N("bitset::flip"));
1139 return _Unchecked_flip(__position);
1142 /// See the no-argument flip().
1144 operator~() const _GLIBCXX_NOEXCEPT
1145 { return bitset<_Nb>(*this).flip(); }
1149 * @brief Array-indexing support.
1150 * @param __position Index into the %bitset.
1151 * @return A bool for a <em>const %bitset</em>. For non-const
1152 * bitsets, an instance of the reference proxy class.
1153 * @note These operators do no range checking and throw no exceptions,
1154 * as required by DR 11 to the standard.
1156 * _GLIBCXX_RESOLVE_LIB_DEFECTS Note that this implementation already
1157 * resolves DR 11 (items 1 and 2), but does not do the range-checking
1158 * required by that DR's resolution. -pme
1159 * The DR has since been changed: range-checking is a precondition
1160 * (users' responsibility), and these functions must not throw. -pme
1163 operator[](size_t __position)
1164 { return reference(*this, __position); }
1166 _GLIBCXX_CONSTEXPR bool
1167 operator[](size_t __position) const
1168 { return _Unchecked_test(__position); }
1172 * @brief Returns a numerical interpretation of the %bitset.
1173 * @return The integral equivalent of the bits.
1174 * @throw std::overflow_error If there are too many bits to be
1175 * represented in an @c unsigned @c long.
1179 { return this->_M_do_to_ulong(); }
1181#if __cplusplus >= 201103L
1184 { return this->_M_do_to_ullong(); }
1188 * @brief Returns a character interpretation of the %bitset.
1189 * @return The string equivalent of the bits.
1191 * Note the ordering of the bits: decreasing character positions
1192 * correspond to increasing bit positions (see the main class notes for
1195 template<class _CharT, class _Traits, class _Alloc>
1196 std::basic_string<_CharT, _Traits, _Alloc>
1199 std::basic_string<_CharT, _Traits, _Alloc> __result;
1200 _M_copy_to_string(__result, _CharT('0'), _CharT('1'));
1204 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1205 // 396. what are characters zero and one.
1206 template<class _CharT, class _Traits, class _Alloc>
1207 std::basic_string<_CharT, _Traits, _Alloc>
1208 to_string(_CharT __zero, _CharT __one = _CharT('1')) const
1210 std::basic_string<_CharT, _Traits, _Alloc> __result;
1211 _M_copy_to_string(__result, __zero, __one);
1215 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1216 // 434. bitset::to_string() hard to use.
1217 template<class _CharT, class _Traits>
1218 std::basic_string<_CharT, _Traits, std::allocator<_CharT> >
1220 { return to_string<_CharT, _Traits, std::allocator<_CharT> >(); }
1222 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1223 // 853. to_string needs updating with zero and one.
1224 template<class _CharT, class _Traits>
1225 std::basic_string<_CharT, _Traits, std::allocator<_CharT> >
1226 to_string(_CharT __zero, _CharT __one = _CharT('1')) const
1227 { return to_string<_CharT, _Traits,
1228 std::allocator<_CharT> >(__zero, __one); }
1230 template<class _CharT>
1231 std::basic_string<_CharT, std::char_traits<_CharT>,
1232 std::allocator<_CharT> >
1235 return to_string<_CharT, std::char_traits<_CharT>,
1236 std::allocator<_CharT> >();
1239 template<class _CharT>
1240 std::basic_string<_CharT, std::char_traits<_CharT>,
1241 std::allocator<_CharT> >
1242 to_string(_CharT __zero, _CharT __one = _CharT('1')) const
1244 return to_string<_CharT, std::char_traits<_CharT>,
1245 std::allocator<_CharT> >(__zero, __one);
1248 std::basic_string<char, std::char_traits<char>, std::allocator<char> >
1251 return to_string<char, std::char_traits<char>,
1252 std::allocator<char> >();
1255 std::basic_string<char, std::char_traits<char>, std::allocator<char> >
1256 to_string(char __zero, char __one = '1') const
1258 return to_string<char, std::char_traits<char>,
1259 std::allocator<char> >(__zero, __one);
1262 // Helper functions for string operations.
1263 template<class _CharT, class _Traits>
1265 _M_copy_from_ptr(const _CharT*, size_t, size_t, size_t,
1268 template<class _CharT, class _Traits, class _Alloc>
1270 _M_copy_from_string(const std::basic_string<_CharT,
1271 _Traits, _Alloc>& __s, size_t __pos, size_t __n,
1272 _CharT __zero, _CharT __one)
1273 { _M_copy_from_ptr<_CharT, _Traits>(__s.data(), __s.size(), __pos, __n,
1276 template<class _CharT, class _Traits, class _Alloc>
1278 _M_copy_to_string(std::basic_string<_CharT, _Traits, _Alloc>&,
1279 _CharT, _CharT) const;
1281 // NB: Backward compat.
1282 template<class _CharT, class _Traits, class _Alloc>
1284 _M_copy_from_string(const std::basic_string<_CharT,
1285 _Traits, _Alloc>& __s, size_t __pos, size_t __n)
1286 { _M_copy_from_string(__s, __pos, __n, _CharT('0'), _CharT('1')); }
1288 template<class _CharT, class _Traits, class _Alloc>
1290 _M_copy_to_string(std::basic_string<_CharT, _Traits,_Alloc>& __s) const
1291 { _M_copy_to_string(__s, _CharT('0'), _CharT('1')); }
1293 /// Returns the number of bits which are set.
1295 count() const _GLIBCXX_NOEXCEPT
1296 { return this->_M_do_count(); }
1298 /// Returns the total number of bits.
1299 _GLIBCXX_CONSTEXPR size_t
1300 size() const _GLIBCXX_NOEXCEPT
1304 /// These comparisons for equality/inequality are, well, @e bitwise.
1306 operator==(const bitset<_Nb>& __rhs) const _GLIBCXX_NOEXCEPT
1307 { return this->_M_is_equal(__rhs); }
1309#if __cpp_impl_three_way_comparison < 201907L
1311 operator!=(const bitset<_Nb>& __rhs) const _GLIBCXX_NOEXCEPT
1312 { return !this->_M_is_equal(__rhs); }
1317 * @brief Tests the value of a bit.
1318 * @param __position The index of a bit.
1319 * @return The value at @a pos.
1320 * @throw std::out_of_range If @a pos is bigger the size of the %set.
1323 test(size_t __position) const
1325 this->_M_check(__position, __N("bitset::test"));
1326 return _Unchecked_test(__position);
1329 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1330 // DR 693. std::bitset::all() missing.
1332 * @brief Tests whether all the bits are on.
1333 * @return True if all the bits are set.
1336 all() const _GLIBCXX_NOEXCEPT
1337 { return this->template _M_are_all<_Nb>(); }
1340 * @brief Tests whether any of the bits are on.
1341 * @return True if at least one bit is set.
1344 any() const _GLIBCXX_NOEXCEPT
1345 { return this->_M_is_any(); }
1348 * @brief Tests whether any of the bits are on.
1349 * @return True if none of the bits are set.
1352 none() const _GLIBCXX_NOEXCEPT
1353 { return !this->_M_is_any(); }
1356 /// Self-explanatory.
1358 operator<<(size_t __position) const _GLIBCXX_NOEXCEPT
1359 { return bitset<_Nb>(*this) <<= __position; }
1362 operator>>(size_t __position) const _GLIBCXX_NOEXCEPT
1363 { return bitset<_Nb>(*this) >>= __position; }
1367 * @brief Finds the index of the first "on" bit.
1368 * @return The index of the first bit set, or size() if not found.
1369 * @ingroup SGIextensions
1373 _Find_first() const _GLIBCXX_NOEXCEPT
1374 { return this->_M_do_find_first(_Nb); }
1377 * @brief Finds the index of the next "on" bit after prev.
1378 * @return The index of the next bit set, or size() if not found.
1379 * @param __prev Where to start searching.
1380 * @ingroup SGIextensions
1384 _Find_next(size_t __prev) const _GLIBCXX_NOEXCEPT
1385 { return this->_M_do_find_next(__prev, _Nb); }
1388 // Definitions of non-inline member functions.
1389 template<size_t _Nb>
1390 template<class _CharT, class _Traits>
1393 _M_copy_from_ptr(const _CharT* __s, size_t __len,
1394 size_t __pos, size_t __n, _CharT __zero, _CharT __one)
1397 const size_t __nbits = std::min(_Nb, std::min(__n, size_t(__len - __pos)));
1398 for (size_t __i = __nbits; __i > 0; --__i)
1400 const _CharT __c = __s[__pos + __nbits - __i];
1401 if (_Traits::eq(__c, __zero))
1403 else if (_Traits::eq(__c, __one))
1404 _Unchecked_set(__i - 1);
1406 __throw_invalid_argument(__N("bitset::_M_copy_from_ptr"));
1410 template<size_t _Nb>
1411 template<class _CharT, class _Traits, class _Alloc>
1414 _M_copy_to_string(std::basic_string<_CharT, _Traits, _Alloc>& __s,
1415 _CharT __zero, _CharT __one) const
1417 __s.assign(_Nb, __zero);
1418 size_t __n = this->_Find_first();
1421 __s[_Nb - __n - 1] = __one;
1422 __n = _Find_next(__n);
1426 // 23.3.5.3 bitset operations:
1429 * @brief Global bitwise operations on bitsets.
1430 * @param __x A bitset.
1431 * @param __y A bitset of the same size as @a __x.
1432 * @return A new bitset.
1434 * These should be self-explanatory.
1436 template<size_t _Nb>
1438 operator&(const bitset<_Nb>& __x, const bitset<_Nb>& __y) _GLIBCXX_NOEXCEPT
1440 bitset<_Nb> __result(__x);
1445 template<size_t _Nb>
1447 operator|(const bitset<_Nb>& __x, const bitset<_Nb>& __y) _GLIBCXX_NOEXCEPT
1449 bitset<_Nb> __result(__x);
1454 template <size_t _Nb>
1456 operator^(const bitset<_Nb>& __x, const bitset<_Nb>& __y) _GLIBCXX_NOEXCEPT
1458 bitset<_Nb> __result(__x);
1466 * @brief Global I/O operators for bitsets.
1468 * Direct I/O between streams and bitsets is supported. Output is
1469 * straightforward. Input will skip whitespace, only accept @a 0 and @a 1
1470 * characters, and will only extract as many digits as the %bitset will
1473 template<class _CharT, class _Traits, size_t _Nb>
1474 std::basic_istream<_CharT, _Traits>&
1475 operator>>(std::basic_istream<_CharT, _Traits>& __is, bitset<_Nb>& __x)
1477 typedef typename _Traits::char_type char_type;
1478 typedef std::basic_istream<_CharT, _Traits> __istream_type;
1479 typedef typename __istream_type::ios_base __ios_base;
1481 std::basic_string<_CharT, _Traits> __tmp;
1484 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1485 // 303. Bitset input operator underspecified
1486 const char_type __zero = __is.widen('0');
1487 const char_type __one = __is.widen('1');
1489 typename __ios_base::iostate __state = __ios_base::goodbit;
1490 typename __istream_type::sentry __sentry(__is);
1495 for (size_t __i = _Nb; __i > 0; --__i)
1497 static typename _Traits::int_type __eof = _Traits::eof();
1499 typename _Traits::int_type __c1 = __is.rdbuf()->sbumpc();
1500 if (_Traits::eq_int_type(__c1, __eof))
1502 __state |= __ios_base::eofbit;
1507 const char_type __c2 = _Traits::to_char_type(__c1);
1508 if (_Traits::eq(__c2, __zero))
1509 __tmp.push_back(__zero);
1510 else if (_Traits::eq(__c2, __one))
1511 __tmp.push_back(__one);
1513 eq_int_type(__is.rdbuf()->sputbackc(__c2),
1516 __state |= __ios_base::failbit;
1522 __catch(__cxxabiv1::__forced_unwind&)
1524 __is._M_setstate(__ios_base::badbit);
1525 __throw_exception_again;
1528 { __is._M_setstate(__ios_base::badbit); }
1531 if (__tmp.empty() && _Nb)
1532 __state |= __ios_base::failbit;
1534 __x._M_copy_from_string(__tmp, static_cast<size_t>(0), _Nb,
1537 __is.setstate(__state);
1541 template <class _CharT, class _Traits, size_t _Nb>
1542 std::basic_ostream<_CharT, _Traits>&
1543 operator<<(std::basic_ostream<_CharT, _Traits>& __os,
1544 const bitset<_Nb>& __x)
1546 std::basic_string<_CharT, _Traits> __tmp;
1548 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1549 // 396. what are characters zero and one.
1550 const ctype<_CharT>& __ct = use_facet<ctype<_CharT> >(__os.getloc());
1551 __x._M_copy_to_string(__tmp, __ct.widen('0'), __ct.widen('1'));
1552 return __os << __tmp;
1556_GLIBCXX_END_NAMESPACE_CONTAINER
1559#undef _GLIBCXX_BITSET_WORDS
1560#undef _GLIBCXX_BITSET_BITS_PER_WORD
1561#undef _GLIBCXX_BITSET_BITS_PER_ULL
1563#if __cplusplus >= 201103L
1565namespace std _GLIBCXX_VISIBILITY(default)
1567_GLIBCXX_BEGIN_NAMESPACE_VERSION
1570 /// std::hash specialization for bitset.
1571 template<size_t _Nb>
1572 struct hash<_GLIBCXX_STD_C::bitset<_Nb>>
1573 : public __hash_base<size_t, _GLIBCXX_STD_C::bitset<_Nb>>
1576 operator()(const _GLIBCXX_STD_C::bitset<_Nb>& __b) const noexcept
1578 const size_t __clength = (_Nb + __CHAR_BIT__ - 1) / __CHAR_BIT__;
1579 return std::_Hash_impl::hash(__b._M_getdata(), __clength);
1584 struct hash<_GLIBCXX_STD_C::bitset<0>>
1585 : public __hash_base<size_t, _GLIBCXX_STD_C::bitset<0>>
1588 operator()(const _GLIBCXX_STD_C::bitset<0>&) const noexcept
1592_GLIBCXX_END_NAMESPACE_VERSION
1597#ifdef _GLIBCXX_DEBUG
1598# include <debug/bitset>
1601#endif /* _GLIBCXX_BITSET */