1 // TR2 <dynamic_bitset> -*- C++ -*-
3 // Copyright (C) 2009-2013 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/>.
25 /** @file tr2/dynamic_bitset
26 * This is a TR2 C++ Library header.
29 #ifndef _GLIBCXX_TR2_DYNAMIC_BITSET
30 #define _GLIBCXX_TR2_DYNAMIC_BITSET 1
32 #pragma GCC system_header
37 #include <memory> // For std::allocator
38 #include <bits/functexcept.h> // For invalid_argument, out_of_range,
41 #include <bits/cxxabi_forced.h>
43 namespace std _GLIBCXX_VISIBILITY(default)
47 _GLIBCXX_BEGIN_NAMESPACE_VERSION
53 * Proposal to Add a Dynamically Sizeable Bitset to the Standard Library.
65 class _Bool2UChar<bool>
68 typedef unsigned char type;
74 * Base class, general case.
76 * See documentation for dynamic_bitset.
78 template<typename _WordT = unsigned long long,
79 typename _Alloc = std::allocator<_WordT>>
80 struct __dynamic_bitset_base
82 static_assert(std::is_unsigned<_WordT>::value, "template argument "
83 "_WordT not an unsigned integral type");
85 typedef _WordT block_type;
86 typedef _Alloc allocator_type;
87 typedef size_t size_type;
89 static const size_type _S_bits_per_block = __CHAR_BIT__ * sizeof(block_type);
90 static const size_type npos = static_cast<size_type>(-1);
92 /// 0 is the least significant word.
93 std::vector<block_type, allocator_type> _M_w;
96 __dynamic_bitset_base(const allocator_type& __alloc = allocator_type())
101 __dynamic_bitset_base(__dynamic_bitset_base&& __b)
102 { this->_M_w.swap(__b._M_w); }
105 __dynamic_bitset_base(size_type __nbits, unsigned long long __val = 0ULL,
106 const allocator_type& __alloc = allocator_type())
107 : _M_w(__nbits / _S_bits_per_block
108 + (__nbits % _S_bits_per_block > 0),
111 unsigned long long __mask = ~static_cast<block_type>(0);
112 size_t __n = std::min(this->_M_w.size(),
113 sizeof(unsigned long long) / sizeof(block_type));
114 for (size_t __i = 0; __i < __n; ++__i)
116 this->_M_w[__i] = (__val & __mask) >> (__i * _S_bits_per_block);
117 __mask <<= _S_bits_per_block;
122 _M_assign(const __dynamic_bitset_base& __b)
123 { this->_M_w = __b._M_w; }
126 _M_swap(__dynamic_bitset_base& __b)
127 { this->_M_w.swap(__b._M_w); }
131 { this->_M_w.clear(); }
134 _M_resize(size_t __nbits, bool __value)
136 size_t __sz = __nbits / _S_bits_per_block;
137 if (__nbits % _S_bits_per_block > 0)
139 if (__sz != this->_M_w.size())
140 this->_M_w.resize(__sz);
144 _M_get_allocator() const
145 { return this->_M_w.get_allocator(); }
148 _S_whichword(size_type __pos) noexcept
149 { return __pos / _S_bits_per_block; }
152 _S_whichbyte(size_type __pos) noexcept
153 { return (__pos % _S_bits_per_block) / __CHAR_BIT__; }
156 _S_whichbit(size_type __pos) noexcept
157 { return __pos % _S_bits_per_block; }
160 _S_maskbit(size_type __pos) noexcept
161 { return (static_cast<block_type>(1)) << _S_whichbit(__pos); }
164 _M_getword(size_type __pos)
165 { return this->_M_w[_S_whichword(__pos)]; }
168 _M_getword(size_type __pos) const
169 { return this->_M_w[_S_whichword(__pos)]; }
173 { return this->_M_w[_M_w.size() - 1]; }
177 { return this->_M_w[_M_w.size() - 1]; }
180 _M_do_and(const __dynamic_bitset_base& __x)
182 if (__x._M_w.size() == this->_M_w.size())
183 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
184 this->_M_w[__i] &= __x._M_w[__i];
190 _M_do_or(const __dynamic_bitset_base& __x)
192 if (__x._M_w.size() == this->_M_w.size())
193 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
194 this->_M_w[__i] |= __x._M_w[__i];
200 _M_do_xor(const __dynamic_bitset_base& __x)
202 if (__x._M_w.size() == this->_M_w.size())
203 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
204 this->_M_w[__i] ^= __x._M_w[__i];
210 _M_do_dif(const __dynamic_bitset_base& __x)
212 if (__x._M_w.size() == this->_M_w.size())
213 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
214 this->_M_w[__i] &= ~__x._M_w[__i];
220 _M_do_left_shift(size_t __shift);
223 _M_do_right_shift(size_t __shift);
228 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
229 this->_M_w[__i] = ~this->_M_w[__i];
235 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
236 this->_M_w[__i] = ~static_cast<block_type>(0);
242 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
243 this->_M_w[__i] = static_cast<block_type>(0);
247 _M_is_equal(const __dynamic_bitset_base& __x) const
249 if (__x.size() == this->size())
251 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
252 if (this->_M_w[__i] != __x._M_w[__i])
261 _M_is_less(const __dynamic_bitset_base& __x) const
263 if (__x.size() == this->size())
265 for (size_t __i = this->_M_w.size(); __i > 0; --__i)
267 if (this->_M_w[__i-1] < __x._M_w[__i-1])
269 else if (this->_M_w[__i-1] > __x._M_w[__i-1])
279 _M_are_all_aux() const
281 for (size_t __i = 0; __i < this->_M_w.size() - 1; ++__i)
282 if (_M_w[__i] != ~static_cast<block_type>(0))
284 return ((this->_M_w.size() - 1) * _S_bits_per_block
285 + __builtin_popcountl(this->_M_hiword()));
291 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
292 if (this->_M_w[__i] != static_cast<block_type>(0))
298 _M_is_subset_of(const __dynamic_bitset_base& __b)
300 if (__b.size() == this->size())
302 for (size_t __i = 0; __i < _M_w.size(); ++__i)
303 if (this->_M_w[__i] != (this->_M_w[__i] | __b._M_w[__i]))
312 _M_is_proper_subset_of(const __dynamic_bitset_base& __b) const
314 if (this->is_subset_of(__b))
329 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
330 __result += __builtin_popcountl(this->_M_w[__i]);
335 _M_size() const noexcept
336 { return this->_M_w.size(); }
339 _M_do_to_ulong() const;
342 _M_do_to_ullong() const;
344 // find first "on" bit
346 _M_do_find_first(size_t __not_found) const;
348 // find the next "on" bit that follows "prev"
350 _M_do_find_next(size_t __prev, size_t __not_found) const;
352 // do append of block
354 _M_do_append_block(block_type __block, size_type __pos)
356 size_t __offset = __pos % _S_bits_per_block;
358 this->_M_w.push_back(__block);
361 this->_M_hiword() |= (__block << __offset);
362 this->_M_w.push_back(__block >> (_S_bits_per_block - __offset));
367 // Definitions of non-inline functions from __dynamic_bitset_base.
368 template<typename _WordT, typename _Alloc>
370 __dynamic_bitset_base<_WordT, _Alloc>::_M_do_left_shift(size_t __shift)
372 if (__builtin_expect(__shift != 0, 1))
374 const size_t __wshift = __shift / _S_bits_per_block;
375 const size_t __offset = __shift % _S_bits_per_block;
378 for (size_t __n = this->_M_w.size() - 1; __n >= __wshift; --__n)
379 this->_M_w[__n] = this->_M_w[__n - __wshift];
382 const size_t __sub_offset = _S_bits_per_block - __offset;
383 for (size_t __n = _M_w.size() - 1; __n > __wshift; --__n)
384 this->_M_w[__n] = ((this->_M_w[__n - __wshift] << __offset)
385 | (this->_M_w[__n - __wshift - 1] >> __sub_offset));
386 this->_M_w[__wshift] = this->_M_w[0] << __offset;
389 //// std::fill(this->_M_w.begin(), this->_M_w.begin() + __wshift,
390 //// static_cast<_WordT>(0));
394 template<typename _WordT, typename _Alloc>
396 __dynamic_bitset_base<_WordT, _Alloc>::_M_do_right_shift(size_t __shift)
398 if (__builtin_expect(__shift != 0, 1))
400 const size_t __wshift = __shift / _S_bits_per_block;
401 const size_t __offset = __shift % _S_bits_per_block;
402 const size_t __limit = this->_M_w.size() - __wshift - 1;
405 for (size_t __n = 0; __n <= __limit; ++__n)
406 this->_M_w[__n] = this->_M_w[__n + __wshift];
409 const size_t __sub_offset = (_S_bits_per_block
411 for (size_t __n = 0; __n < __limit; ++__n)
412 this->_M_w[__n] = ((this->_M_w[__n + __wshift] >> __offset)
413 | (this->_M_w[__n + __wshift + 1] << __sub_offset));
414 this->_M_w[__limit] = this->_M_w[_M_w.size()-1] >> __offset;
417 ////std::fill(this->_M_w.begin() + __limit + 1, this->_M_w.end(),
418 //// static_cast<_WordT>(0));
422 template<typename _WordT, typename _Alloc>
424 __dynamic_bitset_base<_WordT, _Alloc>::_M_do_to_ulong() const
426 size_t __n = sizeof(unsigned long) / sizeof(block_type);
427 for (size_t __i = __n; __i < this->_M_w.size(); ++__i)
429 __throw_overflow_error(__N("__dynamic_bitset_base::_M_do_to_ulong"));
430 unsigned long __res = 0UL;
431 for (size_t __i = 0; __i < __n && __i < this->_M_w.size(); ++__i)
432 __res += this->_M_w[__i] << (__i * _S_bits_per_block);
436 template<typename _WordT, typename _Alloc>
438 __dynamic_bitset_base<_WordT, _Alloc>::_M_do_to_ullong() const
440 size_t __n = sizeof(unsigned long long) / sizeof(block_type);
441 for (size_t __i = __n; __i < this->_M_w.size(); ++__i)
443 __throw_overflow_error(__N("__dynamic_bitset_base::_M_do_to_ullong"));
444 unsigned long long __res = 0ULL;
445 for (size_t __i = 0; __i < __n && __i < this->_M_w.size(); ++__i)
446 __res += this->_M_w[__i] << (__i * _S_bits_per_block);
450 template<typename _WordT, typename _Alloc>
452 __dynamic_bitset_base<_WordT, _Alloc>
453 ::_M_do_find_first(size_t __not_found) const
455 for (size_t __i = 0; __i < this->_M_w.size(); ++__i)
457 _WordT __thisword = this->_M_w[__i];
458 if (__thisword != static_cast<_WordT>(0))
459 return (__i * _S_bits_per_block
460 + __builtin_ctzl(__thisword));
462 // not found, so return an indication of failure.
466 template<typename _WordT, typename _Alloc>
468 __dynamic_bitset_base<_WordT, _Alloc>
469 ::_M_do_find_next(size_t __prev, size_t __not_found) const
471 // make bound inclusive
474 // check out of bounds
475 if (__prev >= this->_M_w.size() * _S_bits_per_block)
479 size_t __i = _S_whichword(__prev);
480 _WordT __thisword = this->_M_w[__i];
482 // mask off bits below bound
483 __thisword &= (~static_cast<_WordT>(0)) << _S_whichbit(__prev);
485 if (__thisword != static_cast<_WordT>(0))
486 return (__i * _S_bits_per_block
487 + __builtin_ctzl(__thisword));
489 // check subsequent words
490 for (++__i; __i < this->_M_w.size(); ++__i)
492 __thisword = this->_M_w[__i];
493 if (__thisword != static_cast<_WordT>(0))
494 return (__i * _S_bits_per_block
495 + __builtin_ctzl(__thisword));
497 // not found, so return an indication of failure.
499 } // end _M_do_find_next
502 * @brief The %dynamic_bitset class represents a sequence of bits.
504 * @ingroup containers
506 * (Note that %dynamic_bitset does @e not meet the formal
507 * requirements of a <a href="tables.html#65">container</a>.
508 * Mainly, it lacks iterators.)
510 * The template argument, @a Nb, may be any non-negative number,
511 * specifying the number of bits (e.g., "0", "12", "1024*1024").
513 * In the general unoptimized case, storage is allocated in
514 * word-sized blocks. Let B be the number of bits in a word, then
515 * (Nb+(B-1))/B words will be used for storage. B - Nb%B bits are
516 * unused. (They are the high-order bits in the highest word.) It
517 * is a class invariant that those unused bits are always zero.
519 * If you think of %dynamic_bitset as "a simple array of bits," be
520 * aware that your mental picture is reversed: a %dynamic_bitset
521 * behaves the same way as bits in integers do, with the bit at
522 * index 0 in the "least significant / right-hand" position, and
523 * the bit at index Nb-1 in the "most significant / left-hand"
524 * position. Thus, unlike other containers, a %dynamic_bitset's
525 * index "counts from right to left," to put it very loosely.
527 * This behavior is preserved when translating to and from strings.
528 * For example, the first line of the following program probably
529 * prints "b('a') is 0001100001" on a modern ASCII system.
532 * #include <dynamic_bitset>
533 * #include <iostream>
536 * using namespace std;
541 * dynamic_bitset b(a);
543 * cout << "b('a') is " << b << endl;
547 * string str = s.str();
548 * cout << "index 3 in the string is " << str[3] << " but\n"
549 * << "index 3 in the bitset is " << b[3] << endl;
554 * http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt12ch33s02.html
555 * for a description of extensions.
557 * Most of the actual code isn't contained in %dynamic_bitset<>
558 * itself, but in the base class __dynamic_bitset_base. The base
559 * class works with whole words, not with individual bits. This
560 * allows us to specialize __dynamic_bitset_base for the important
561 * special case where the %dynamic_bitset is only a single word.
563 * Extra confusion can result due to the fact that the storage for
564 * __dynamic_bitset_base @e is a vector, and is indexed as such. This is
565 * carefully encapsulated.
567 template<typename _WordT = unsigned long long,
568 typename _Alloc = std::allocator<_WordT>>
570 : private __dynamic_bitset_base<_WordT, _Alloc>
572 static_assert(std::is_unsigned<_WordT>::value, "template argument "
573 "_WordT not an unsigned integral type");
577 typedef __dynamic_bitset_base<_WordT, _Alloc> _Base;
578 typedef _WordT block_type;
579 typedef _Alloc allocator_type;
580 typedef size_t size_type;
582 static const size_type bits_per_block = __CHAR_BIT__ * sizeof(block_type);
583 // Use this: constexpr size_type std::numeric_limits<size_type>::max().
584 static const size_type npos = static_cast<size_type>(-1);
588 // Clear the unused bits in the uppermost word.
592 size_type __shift = this->_M_Nb % bits_per_block;
594 this->_M_hiword() &= ~((~static_cast<block_type>(0)) << __shift);
598 * These versions of single-bit set, reset, flip, and test
599 * do no range checking.
601 dynamic_bitset<_WordT, _Alloc>&
602 _M_unchecked_set(size_type __pos)
604 this->_M_getword(__pos) |= _Base::_S_maskbit(__pos);
608 dynamic_bitset<_WordT, _Alloc>&
609 _M_unchecked_set(size_type __pos, int __val)
612 this->_M_getword(__pos) |= _Base::_S_maskbit(__pos);
614 this->_M_getword(__pos) &= ~_Base::_S_maskbit(__pos);
618 dynamic_bitset<_WordT, _Alloc>&
619 _M_unchecked_reset(size_type __pos)
621 this->_M_getword(__pos) &= ~_Base::_S_maskbit(__pos);
625 dynamic_bitset<_WordT, _Alloc>&
626 _M_unchecked_flip(size_type __pos)
628 this->_M_getword(__pos) ^= _Base::_S_maskbit(__pos);
633 _M_unchecked_test(size_type __pos) const
634 { return ((this->_M_getword(__pos) & _Base::_S_maskbit(__pos))
635 != static_cast<_WordT>(0)); }
641 * This encapsulates the concept of a single bit. An instance
642 * of this class is a proxy for an actual bit; this way the
643 * individual bit operations are done as faster word-size
644 * bitwise instructions.
646 * Most users will never need to use this class directly;
647 * conversions to and from bool are automatic and should be
648 * transparent. Overloaded operators help to preserve the
651 * (On a typical system, this "bit %reference" is 64 times the
652 * size of an actual bit. Ha.)
656 friend class dynamic_bitset;
665 reference(dynamic_bitset& __b, size_type __pos)
667 this->_M_wp = &__b._M_getword(__pos);
668 this->_M_bpos = _Base::_S_whichbit(__pos);
679 *this->_M_wp |= _Base::_S_maskbit(this->_M_bpos);
681 *this->_M_wp &= ~_Base::_S_maskbit(this->_M_bpos);
685 // For b[i] = b[__j];
687 operator=(const reference& __j)
689 if ((*(__j._M_wp) & _Base::_S_maskbit(__j._M_bpos)))
690 *this->_M_wp |= _Base::_S_maskbit(this->_M_bpos);
692 *this->_M_wp &= ~_Base::_S_maskbit(this->_M_bpos);
699 { return (*(_M_wp) & _Base::_S_maskbit(this->_M_bpos)) == 0; }
702 operator bool() const
703 { return (*(this->_M_wp) & _Base::_S_maskbit(this->_M_bpos)) != 0; }
709 *this->_M_wp ^= _Base::_S_maskbit(this->_M_bpos);
714 friend class reference;
716 typedef bool const_reference;
718 // 23.3.5.1 constructors:
719 /// All bits set to zero.
721 dynamic_bitset(const allocator_type& __alloc = allocator_type())
722 : _Base(__alloc), _M_Nb(0)
725 /// Initial bits bitwise-copied from a single word (others set to zero).
727 dynamic_bitset(size_type __nbits, unsigned long long __val = 0ULL,
728 const allocator_type& __alloc = allocator_type())
729 : _Base(__nbits, __val, __alloc),
733 dynamic_bitset(initializer_list<block_type> __il,
734 const allocator_type& __alloc = allocator_type())
735 : _Base(__alloc), _M_Nb(0)
736 { this->append(__il); }
739 * @brief Use a subset of a string.
740 * @param __str A string of '0' and '1' characters.
741 * @param __pos Index of the first character in @p __str to use.
742 * @param __n The number of characters to copy.
743 * @throw std::out_of_range If @p __pos is bigger the size of @p __str.
744 * @throw std::invalid_argument If a character appears in the string
745 * which is neither '0' nor '1'.
747 template<typename _CharT, typename _Traits, typename _Alloc1>
749 dynamic_bitset(const std::basic_string<_CharT, _Traits, _Alloc1>& __str,
750 typename basic_string<_CharT,_Traits,_Alloc1>::size_type
752 typename basic_string<_CharT,_Traits,_Alloc1>::size_type
753 __n = std::basic_string<_CharT, _Traits, _Alloc1>::npos,
754 _CharT __zero = _CharT('0'), _CharT __one = _CharT('1'),
755 const allocator_type& __alloc = allocator_type())
757 _M_Nb(0) // Watch for npos.
759 if (__pos > __str.size())
760 __throw_out_of_range(__N("dynamic_bitset::bitset initial position "
764 this->_M_Nb = (__n > __str.size() ? __str.size() - __pos : __n);
765 this->resize(this->_M_Nb);
766 this->_M_copy_from_string(__str, __pos, __n,
767 _CharT('0'), _CharT('1'));
771 * @brief Construct from a string.
772 * @param __str A string of '0' and '1' characters.
773 * @throw std::invalid_argument If a character appears in the string
774 * which is neither '0' nor '1'.
777 dynamic_bitset(const char* __str,
778 const allocator_type& __alloc = allocator_type())
783 while (__str[__len] != '\0')
786 this->_M_copy_from_ptr<char,std::char_traits<char>>
787 (__str, __len, 0, __len, '0', '1');
791 * @brief Copy constructor.
793 dynamic_bitset(const dynamic_bitset& __b)
794 : _Base(__b), _M_Nb(__b.size())
798 * @brief Move constructor.
800 dynamic_bitset(dynamic_bitset&& __b)
801 : _Base(std::forward<_Base>(__b)), _M_Nb(__b.size())
805 * @brief Swap with another bitset.
808 swap(dynamic_bitset& __b)
811 std::swap(this->_M_Nb, __b._M_Nb);
818 operator=(const dynamic_bitset& __b)
822 this->_M_assign(__b);
823 this->_M_Nb = __b._M_Nb;
828 * @brief Move assignment.
831 operator=(dynamic_bitset&& __b)
838 * @brief Return the allocator for the bitset.
841 get_allocator() const
842 { return this->_M_get_allocator(); }
845 * @brief Resize the bitset.
848 resize(size_type __nbits, bool __value = false)
850 this->_M_resize(__nbits, __value);
851 this->_M_Nb = __nbits;
852 this->_M_do_sanitize();
856 * @brief Clear the bitset.
866 * @brief Push a bit onto the high end of the bitset.
869 push_back(bool __bit)
871 if (size_t __offset = this->size() % bits_per_block == 0)
872 this->_M_do_append_block(block_type(0), this->_M_Nb);
874 this->_M_unchecked_set(this->_M_Nb, __bit);
878 * @brief Append a block.
881 append(block_type __block)
883 this->_M_do_append_block(__block, this->_M_Nb);
884 this->_M_Nb += bits_per_block;
891 append(initializer_list<block_type> __il)
892 { this->append(__il.begin(), __il.end()); }
895 * @brief Append an iterator range of blocks.
897 template <typename _BlockInputIterator>
899 append(_BlockInputIterator __first, _BlockInputIterator __last)
901 for (; __first != __last; ++__first)
902 this->append(*__first);
905 // 23.3.5.2 dynamic_bitset operations:
908 * @brief Operations on dynamic_bitsets.
909 * @param __rhs A same-sized dynamic_bitset.
911 * These should be self-explanatory.
913 dynamic_bitset<_WordT, _Alloc>&
914 operator&=(const dynamic_bitset<_WordT, _Alloc>& __rhs)
916 this->_M_do_and(__rhs);
920 dynamic_bitset<_WordT, _Alloc>&
921 operator&=(dynamic_bitset<_WordT, _Alloc>&& __rhs)
923 this->_M_do_and(std::move(__rhs));
927 dynamic_bitset<_WordT, _Alloc>&
928 operator|=(const dynamic_bitset<_WordT, _Alloc>& __rhs)
930 this->_M_do_or(__rhs);
934 dynamic_bitset<_WordT, _Alloc>&
935 operator^=(const dynamic_bitset<_WordT, _Alloc>& __rhs)
937 this->_M_do_xor(__rhs);
941 dynamic_bitset<_WordT, _Alloc>&
942 operator-=(const dynamic_bitset<_WordT, _Alloc>& __rhs)
944 this->_M_do_dif(__rhs);
951 * @brief Operations on dynamic_bitsets.
952 * @param __pos The number of places to shift.
954 * These should be self-explanatory.
956 dynamic_bitset<_WordT, _Alloc>&
957 operator<<=(size_type __pos)
959 if (__builtin_expect(__pos < this->_M_Nb, 1))
961 this->_M_do_left_shift(__pos);
962 this->_M_do_sanitize();
969 dynamic_bitset<_WordT, _Alloc>&
970 operator>>=(size_type __pos)
972 if (__builtin_expect(__pos < this->_M_Nb, 1))
974 this->_M_do_right_shift(__pos);
975 this->_M_do_sanitize();
983 // Set, reset, and flip.
985 * @brief Sets every bit to true.
987 dynamic_bitset<_WordT, _Alloc>&
991 this->_M_do_sanitize();
996 * @brief Sets a given bit to a particular value.
997 * @param __pos The index of the bit.
998 * @param __val Either true or false, defaults to true.
999 * @throw std::out_of_range If @a __pos is bigger the size of the %set.
1001 dynamic_bitset<_WordT, _Alloc>&
1002 set(size_type __pos, bool __val = true)
1005 __throw_out_of_range(__N("dynamic_bitset::set"));
1006 return this->_M_unchecked_set(__pos, __val);
1010 * @brief Sets every bit to false.
1012 dynamic_bitset<_WordT, _Alloc>&
1015 this->_M_do_reset();
1020 * @brief Sets a given bit to false.
1021 * @param __pos The index of the bit.
1022 * @throw std::out_of_range If @a __pos is bigger the size of the %set.
1024 * Same as writing @c set(__pos, false).
1026 dynamic_bitset<_WordT, _Alloc>&
1027 reset(size_type __pos)
1030 __throw_out_of_range(__N("dynamic_bitset::reset"));
1031 return this->_M_unchecked_reset(__pos);
1035 * @brief Toggles every bit to its opposite value.
1037 dynamic_bitset<_WordT, _Alloc>&
1041 this->_M_do_sanitize();
1046 * @brief Toggles a given bit to its opposite value.
1047 * @param __pos The index of the bit.
1048 * @throw std::out_of_range If @a __pos is bigger the size of the %set.
1050 dynamic_bitset<_WordT, _Alloc>&
1051 flip(size_type __pos)
1054 __throw_out_of_range(__N("dynamic_bitset::flip"));
1055 return this->_M_unchecked_flip(__pos);
1058 /// See the no-argument flip().
1059 dynamic_bitset<_WordT, _Alloc>
1061 { return dynamic_bitset<_WordT, _Alloc>(*this).flip(); }
1065 * @brief Array-indexing support.
1066 * @param __pos Index into the %dynamic_bitset.
1067 * @return A bool for a 'const %dynamic_bitset'. For non-const
1068 * bitsets, an instance of the reference proxy class.
1069 * @note These operators do no range checking and throw no
1070 * exceptions, as required by DR 11 to the standard.
1073 operator[](size_type __pos)
1074 { return reference(*this,__pos); }
1077 operator[](size_type __pos) const
1078 { return _M_unchecked_test(__pos); }
1082 * @brief Returns a numerical interpretation of the %dynamic_bitset.
1083 * @return The integral equivalent of the bits.
1084 * @throw std::overflow_error If there are too many bits to be
1085 * represented in an @c unsigned @c long.
1089 { return this->_M_do_to_ulong(); }
1092 * @brief Returns a numerical interpretation of the %dynamic_bitset.
1093 * @return The integral equivalent of the bits.
1094 * @throw std::overflow_error If there are too many bits to be
1095 * represented in an @c unsigned @c long.
1099 { return this->_M_do_to_ullong(); }
1102 * @brief Returns a character interpretation of the %dynamic_bitset.
1103 * @return The string equivalent of the bits.
1105 * Note the ordering of the bits: decreasing character positions
1106 * correspond to increasing bit positions (see the main class notes for
1109 template<typename _CharT = char,
1110 typename _Traits = std::char_traits<_CharT>,
1111 typename _Alloc1 = std::allocator<_CharT>>
1112 std::basic_string<_CharT, _Traits, _Alloc1>
1113 to_string(_CharT __zero = _CharT('0'), _CharT __one = _CharT('1')) const
1115 std::basic_string<_CharT, _Traits, _Alloc1> __result;
1116 _M_copy_to_string(__result, __zero, __one);
1120 // Helper functions for string operations.
1121 template<typename _CharT, typename _Traits>
1123 _M_copy_from_ptr(const _CharT*, size_t, size_t, size_t,
1126 template<typename _CharT, typename _Traits, typename _Alloc1>
1128 _M_copy_from_string(const std::basic_string<_CharT,
1129 _Traits, _Alloc1>& __str, size_t __pos, size_t __n,
1130 _CharT __zero = _CharT('0'),
1131 _CharT __one = _CharT('1'))
1132 { _M_copy_from_ptr<_CharT, _Traits>(__str.data(), __str.size(),
1133 __pos, __n, __zero, __one); }
1135 template<typename _CharT, typename _Traits, typename _Alloc1>
1137 _M_copy_to_string(std::basic_string<_CharT, _Traits, _Alloc1>& __str,
1138 _CharT __zero = _CharT('0'),
1139 _CharT __one = _CharT('1')) const;
1141 /// Returns the number of bits which are set.
1143 count() const noexcept
1144 { return this->_M_do_count(); }
1146 /// Returns the total number of bits.
1148 size() const noexcept
1149 { return this->_M_Nb; }
1151 /// Returns the total number of blocks.
1153 num_blocks() const noexcept
1154 { return this->_M_size(); }
1156 /// Returns true if the dynamic_bitset is empty.
1158 empty() const noexcept
1159 { return (this->_M_Nb == 0); }
1161 /// Returns the maximum size of a dynamic_bitset object having the same
1163 /// The real answer is max() * bits_per_block but is likely to overflow.
1166 { return std::numeric_limits<block_type>::max(); }
1169 * @brief Tests the value of a bit.
1170 * @param __pos The index of a bit.
1171 * @return The value at @a __pos.
1172 * @throw std::out_of_range If @a __pos is bigger the size of the %set.
1175 test(size_type __pos) const
1178 __throw_out_of_range(__N("dynamic_bitset::test"));
1179 return _M_unchecked_test(__pos);
1183 * @brief Tests whether all the bits are on.
1184 * @return True if all the bits are set.
1188 { return this->_M_are_all_aux() == _M_Nb; }
1191 * @brief Tests whether any of the bits are on.
1192 * @return True if at least one bit is set.
1196 { return this->_M_is_any(); }
1199 * @brief Tests whether any of the bits are on.
1200 * @return True if none of the bits are set.
1204 { return !this->_M_is_any(); }
1207 /// Self-explanatory.
1208 dynamic_bitset<_WordT, _Alloc>
1209 operator<<(size_type __pos) const
1210 { return dynamic_bitset<_WordT, _Alloc>(*this) <<= __pos; }
1212 dynamic_bitset<_WordT, _Alloc>
1213 operator>>(size_type __pos) const
1214 { return dynamic_bitset<_WordT, _Alloc>(*this) >>= __pos; }
1218 * @brief Finds the index of the first "on" bit.
1219 * @return The index of the first bit set, or size() if not found.
1224 { return this->_M_do_find_first(this->_M_Nb); }
1227 * @brief Finds the index of the next "on" bit after prev.
1228 * @return The index of the next bit set, or size() if not found.
1229 * @param __prev Where to start searching.
1233 find_next(size_t __prev) const
1234 { return this->_M_do_find_next(__prev, this->_M_Nb); }
1237 is_subset_of(const dynamic_bitset& __b) const
1238 { return this->_M_is_subset_of(__b); }
1241 is_proper_subset_of(const dynamic_bitset& __b) const
1242 { return this->_M_is_proper_subset_of(__b); }
1245 // Definitions of non-inline member functions.
1246 template<typename _WordT, typename _Alloc>
1247 template<typename _CharT, typename _Traits>
1249 dynamic_bitset<_WordT, _Alloc>::
1250 _M_copy_from_ptr(const _CharT* __str, size_t __len,
1251 size_t __pos, size_t __n, _CharT __zero, _CharT __one)
1254 const size_t __nbits = std::min(_M_Nb, std::min(__n, __len - __pos));
1255 for (size_t __i = __nbits; __i > 0; --__i)
1257 const _CharT __c = __str[__pos + __nbits - __i];
1258 if (_Traits::eq(__c, __zero))
1260 else if (_Traits::eq(__c, __one))
1261 _M_unchecked_set(__i - 1);
1263 __throw_invalid_argument(__N("dynamic_bitset::_M_copy_from_ptr"));
1267 template<typename _WordT, typename _Alloc>
1268 template<typename _CharT, typename _Traits, typename _Alloc1>
1270 dynamic_bitset<_WordT, _Alloc>::
1271 _M_copy_to_string(std::basic_string<_CharT, _Traits, _Alloc1>& __str,
1272 _CharT __zero, _CharT __one) const
1274 __str.assign(_M_Nb, __zero);
1275 for (size_t __i = _M_Nb; __i > 0; --__i)
1276 if (_M_unchecked_test(__i - 1))
1277 _Traits::assign(__str[_M_Nb - __i], __one);
1282 /// These comparisons for equality/inequality are, well, @e bitwise.
1283 template<typename _WordT, typename _Alloc>
1285 operator==(const dynamic_bitset<_WordT, _Alloc>& __lhs,
1286 const dynamic_bitset<_WordT, _Alloc>& __rhs)
1287 { return __lhs._M_is_equal(__rhs); }
1289 template<typename _WordT, typename _Alloc>
1291 operator!=(const dynamic_bitset<_WordT, _Alloc>& __lhs,
1292 const dynamic_bitset<_WordT, _Alloc>& __rhs)
1293 { return !__lhs._M_is_equal(__rhs); }
1295 template<typename _WordT, typename _Alloc>
1297 operator<(const dynamic_bitset<_WordT, _Alloc>& __lhs,
1298 const dynamic_bitset<_WordT, _Alloc>& __rhs)
1299 { return __lhs._M_is_less(__rhs); }
1301 template<typename _WordT, typename _Alloc>
1303 operator<=(const dynamic_bitset<_WordT, _Alloc>& __lhs,
1304 const dynamic_bitset<_WordT, _Alloc>& __rhs)
1305 { return !(__lhs > __rhs); }
1307 template<typename _WordT, typename _Alloc>
1309 operator>(const dynamic_bitset<_WordT, _Alloc>& __lhs,
1310 const dynamic_bitset<_WordT, _Alloc>& __rhs)
1311 { return __rhs < __lhs; }
1313 template<typename _WordT, typename _Alloc>
1315 operator>=(const dynamic_bitset<_WordT, _Alloc>& __lhs,
1316 const dynamic_bitset<_WordT, _Alloc>& __rhs)
1317 { return !(__lhs < __rhs); }
1320 // 23.3.5.3 bitset operations:
1323 * @brief Global bitwise operations on bitsets.
1324 * @param __x A bitset.
1325 * @param __y A bitset of the same size as @a __x.
1326 * @return A new bitset.
1328 * These should be self-explanatory.
1330 template<typename _WordT, typename _Alloc>
1331 inline dynamic_bitset<_WordT, _Alloc>
1332 operator&(const dynamic_bitset<_WordT, _Alloc>& __x,
1333 const dynamic_bitset<_WordT, _Alloc>& __y)
1335 dynamic_bitset<_WordT, _Alloc> __result(__x);
1340 template<typename _WordT, typename _Alloc>
1341 inline dynamic_bitset<_WordT, _Alloc>
1342 operator|(const dynamic_bitset<_WordT, _Alloc>& __x,
1343 const dynamic_bitset<_WordT, _Alloc>& __y)
1345 dynamic_bitset<_WordT, _Alloc> __result(__x);
1350 template <typename _WordT, typename _Alloc>
1351 inline dynamic_bitset<_WordT, _Alloc>
1352 operator^(const dynamic_bitset<_WordT, _Alloc>& __x,
1353 const dynamic_bitset<_WordT, _Alloc>& __y)
1355 dynamic_bitset<_WordT, _Alloc> __result(__x);
1360 template <typename _WordT, typename _Alloc>
1361 inline dynamic_bitset<_WordT, _Alloc>
1362 operator-(const dynamic_bitset<_WordT, _Alloc>& __x,
1363 const dynamic_bitset<_WordT, _Alloc>& __y)
1365 dynamic_bitset<_WordT, _Alloc> __result(__x);
1373 * @brief Global I/O operators for bitsets.
1375 * Direct I/O between streams and bitsets is supported. Output is
1376 * straightforward. Input will skip whitespace and only accept '0'
1377 * and '1' characters. The %dynamic_bitset will grow as necessary
1378 * to hold the string of bits.
1380 template<typename _CharT, typename _Traits,
1381 typename _WordT, typename _Alloc>
1382 std::basic_istream<_CharT, _Traits>&
1383 operator>>(std::basic_istream<_CharT, _Traits>& __is,
1384 dynamic_bitset<_WordT, _Alloc>& __x)
1386 typedef typename _Traits::char_type char_type;
1387 typedef std::basic_istream<_CharT, _Traits> __istream_type;
1388 typedef typename __istream_type::ios_base __ios_base;
1390 std::basic_string<_CharT, _Traits> __tmp;
1391 __tmp.reserve(__x.size());
1393 const char_type __zero = __is.widen('0');
1394 const char_type __one = __is.widen('1');
1396 typename __ios_base::iostate __state = __ios_base::goodbit;
1397 typename __istream_type::sentry __sentry(__is);
1404 static typename _Traits::int_type __eof = _Traits::eof();
1406 typename _Traits::int_type __c1 = __is.rdbuf()->sbumpc();
1407 if (_Traits::eq_int_type(__c1, __eof))
1409 __state |= __ios_base::eofbit;
1414 const char_type __c2 = _Traits::to_char_type(__c1);
1415 if (_Traits::eq(__c2, __zero))
1416 __tmp.push_back(__zero);
1417 else if (_Traits::eq(__c2, __one))
1418 __tmp.push_back(__one);
1420 eq_int_type(__is.rdbuf()->sputbackc(__c2),
1423 __state |= __ios_base::failbit;
1431 __catch(__cxxabiv1::__forced_unwind&)
1433 __is._M_setstate(__ios_base::badbit);
1434 __throw_exception_again;
1437 { __is._M_setstate(__ios_base::badbit); }
1440 __x.resize(__tmp.size());
1442 if (__tmp.empty() && __x.size())
1443 __state |= __ios_base::failbit;
1445 __x._M_copy_from_string(__tmp, static_cast<size_t>(0), __x.size(),
1448 __is.setstate(__state);
1452 template <typename _CharT, typename _Traits,
1453 typename _WordT, typename _Alloc>
1454 std::basic_ostream<_CharT, _Traits>&
1455 operator<<(std::basic_ostream<_CharT, _Traits>& __os,
1456 const dynamic_bitset<_WordT, _Alloc>& __x)
1458 std::basic_string<_CharT, _Traits> __tmp;
1460 const ctype<_CharT>& __ct = use_facet<ctype<_CharT>>(__os.getloc());
1461 __x._M_copy_to_string(__tmp, __ct.widen('0'), __ct.widen('1'));
1462 return __os << __tmp;
1466 _GLIBCXX_END_NAMESPACE_VERSION
1470 #undef _GLIBCXX_BITSET_BITS_PER_WORD
1472 #endif /* _GLIBCXX_TR2_DYNAMIC_BITSET */