1 // vector<bool> specialization -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
29 * Hewlett-Packard Company
31 * Permission to use, copy, modify, distribute and sell this software
32 * and its documentation for any purpose is hereby granted without fee,
33 * provided that the above copyright notice appear in all copies and
34 * that both that copyright notice and this permission notice appear
35 * in supporting documentation. Hewlett-Packard Company makes no
36 * representations about the suitability of this software for any
37 * purpose. It is provided "as is" without express or implied warranty.
40 * Copyright (c) 1996-1999
41 * Silicon Graphics Computer Systems, Inc.
43 * Permission to use, copy, modify, distribute and sell this software
44 * and its documentation for any purpose is hereby granted without fee,
45 * provided that the above copyright notice appear in all copies and
46 * that both that copyright notice and this permission notice appear
47 * in supporting documentation. Silicon Graphics makes no
48 * representations about the suitability of this software for any
49 * purpose. It is provided "as is" without express or implied warranty.
52 /** @file bits/stl_bvector.h
53 * This is an internal header file, included by other library headers.
54 * Do not attempt to use it directly. @headername{vector}
57 #ifndef _STL_BVECTOR_H
58 #define _STL_BVECTOR_H 1
60 #include <initializer_list>
62 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)
64 typedef unsigned long _Bit_type;
65 enum { _S_word_bit = int(__CHAR_BIT__ * sizeof(_Bit_type)) };
72 _Bit_reference(_Bit_type * __x, _Bit_type __y)
73 : _M_p(__x), _M_mask(__y) { }
75 _Bit_reference() : _M_p(0), _M_mask(0) { }
78 { return !!(*_M_p & _M_mask); }
91 operator=(const _Bit_reference& __x)
92 { return *this = bool(__x); }
95 operator==(const _Bit_reference& __x) const
96 { return bool(*this) == bool(__x); }
99 operator<(const _Bit_reference& __x) const
100 { return !bool(*this) && bool(__x); }
104 { *_M_p ^= _M_mask; }
107 struct _Bit_iterator_base
108 : public std::iterator<std::random_access_iterator_tag, bool>
111 unsigned int _M_offset;
113 _Bit_iterator_base(_Bit_type * __x, unsigned int __y)
114 : _M_p(__x), _M_offset(__y) { }
119 if (_M_offset++ == int(_S_word_bit) - 1)
129 if (_M_offset-- == 0)
131 _M_offset = int(_S_word_bit) - 1;
137 _M_incr(ptrdiff_t __i)
139 difference_type __n = __i + _M_offset;
140 _M_p += __n / int(_S_word_bit);
141 __n = __n % int(_S_word_bit);
144 __n += int(_S_word_bit);
147 _M_offset = static_cast<unsigned int>(__n);
151 operator==(const _Bit_iterator_base& __i) const
152 { return _M_p == __i._M_p && _M_offset == __i._M_offset; }
155 operator<(const _Bit_iterator_base& __i) const
157 return _M_p < __i._M_p
158 || (_M_p == __i._M_p && _M_offset < __i._M_offset);
162 operator!=(const _Bit_iterator_base& __i) const
163 { return !(*this == __i); }
166 operator>(const _Bit_iterator_base& __i) const
167 { return __i < *this; }
170 operator<=(const _Bit_iterator_base& __i) const
171 { return !(__i < *this); }
174 operator>=(const _Bit_iterator_base& __i) const
175 { return !(*this < __i); }
179 operator-(const _Bit_iterator_base& __x, const _Bit_iterator_base& __y)
181 return (int(_S_word_bit) * (__x._M_p - __y._M_p)
182 + __x._M_offset - __y._M_offset);
185 struct _Bit_iterator : public _Bit_iterator_base
187 typedef _Bit_reference reference;
188 typedef _Bit_reference* pointer;
189 typedef _Bit_iterator iterator;
191 _Bit_iterator() : _Bit_iterator_base(0, 0) { }
193 _Bit_iterator(_Bit_type * __x, unsigned int __y)
194 : _Bit_iterator_base(__x, __y) { }
198 { return reference(_M_p, 1UL << _M_offset); }
210 iterator __tmp = *this;
225 iterator __tmp = *this;
231 operator+=(difference_type __i)
238 operator-=(difference_type __i)
245 operator+(difference_type __i) const
247 iterator __tmp = *this;
252 operator-(difference_type __i) const
254 iterator __tmp = *this;
259 operator[](difference_type __i) const
260 { return *(*this + __i); }
264 operator+(ptrdiff_t __n, const _Bit_iterator& __x)
265 { return __x + __n; }
267 struct _Bit_const_iterator : public _Bit_iterator_base
269 typedef bool reference;
270 typedef bool const_reference;
271 typedef const bool* pointer;
272 typedef _Bit_const_iterator const_iterator;
274 _Bit_const_iterator() : _Bit_iterator_base(0, 0) { }
276 _Bit_const_iterator(_Bit_type * __x, unsigned int __y)
277 : _Bit_iterator_base(__x, __y) { }
279 _Bit_const_iterator(const _Bit_iterator& __x)
280 : _Bit_iterator_base(__x._M_p, __x._M_offset) { }
284 { return _Bit_reference(_M_p, 1UL << _M_offset); }
296 const_iterator __tmp = *this;
311 const_iterator __tmp = *this;
317 operator+=(difference_type __i)
324 operator-=(difference_type __i)
331 operator+(difference_type __i) const
333 const_iterator __tmp = *this;
338 operator-(difference_type __i) const
340 const_iterator __tmp = *this;
345 operator[](difference_type __i) const
346 { return *(*this + __i); }
349 inline _Bit_const_iterator
350 operator+(ptrdiff_t __n, const _Bit_const_iterator& __x)
351 { return __x + __n; }
354 __fill_bvector(_Bit_iterator __first, _Bit_iterator __last, bool __x)
356 for (; __first != __last; ++__first)
361 fill(_Bit_iterator __first, _Bit_iterator __last, const bool& __x)
363 if (__first._M_p != __last._M_p)
365 std::fill(__first._M_p + 1, __last._M_p, __x ? ~0 : 0);
366 __fill_bvector(__first, _Bit_iterator(__first._M_p + 1, 0), __x);
367 __fill_bvector(_Bit_iterator(__last._M_p, 0), __last, __x);
370 __fill_bvector(__first, __last, __x);
373 template<typename _Alloc>
376 typedef typename _Alloc::template rebind<_Bit_type>::other
380 : public _Bit_alloc_type
382 _Bit_iterator _M_start;
383 _Bit_iterator _M_finish;
384 _Bit_type* _M_end_of_storage;
387 : _Bit_alloc_type(), _M_start(), _M_finish(), _M_end_of_storage(0)
390 _Bvector_impl(const _Bit_alloc_type& __a)
391 : _Bit_alloc_type(__a), _M_start(), _M_finish(), _M_end_of_storage(0)
396 typedef _Alloc allocator_type;
399 _M_get_Bit_allocator()
400 { return *static_cast<_Bit_alloc_type*>(&this->_M_impl); }
402 const _Bit_alloc_type&
403 _M_get_Bit_allocator() const
404 { return *static_cast<const _Bit_alloc_type*>(&this->_M_impl); }
407 get_allocator() const
408 { return allocator_type(_M_get_Bit_allocator()); }
413 _Bvector_base(const allocator_type& __a)
416 #ifdef __GXX_EXPERIMENTAL_CXX0X__
417 _Bvector_base(_Bvector_base&& __x)
418 : _M_impl(__x._M_get_Bit_allocator())
420 this->_M_impl._M_start = __x._M_impl._M_start;
421 this->_M_impl._M_finish = __x._M_impl._M_finish;
422 this->_M_impl._M_end_of_storage = __x._M_impl._M_end_of_storage;
423 __x._M_impl._M_start = _Bit_iterator();
424 __x._M_impl._M_finish = _Bit_iterator();
425 __x._M_impl._M_end_of_storage = 0;
430 { this->_M_deallocate(); }
433 _Bvector_impl _M_impl;
436 _M_allocate(size_t __n)
437 { return _M_impl.allocate((__n + int(_S_word_bit) - 1)
438 / int(_S_word_bit)); }
443 if (_M_impl._M_start._M_p)
444 _M_impl.deallocate(_M_impl._M_start._M_p,
445 _M_impl._M_end_of_storage - _M_impl._M_start._M_p);
449 _GLIBCXX_END_NESTED_NAMESPACE
451 // Declare a partial specialization of vector<T, Alloc>.
452 #include <bits/stl_vector.h>
454 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD_D)
457 * @brief A specialization of vector for booleans which offers fixed time
458 * access to individual elements in any order.
460 * Note that vector<bool> does not actually meet the requirements for being
461 * a container. This is because the reference and pointer types are not
462 * really references and pointers to bool. See DR96 for details. @see
463 * vector for function documentation.
467 * In some terminology a %vector can be described as a dynamic
468 * C-style array, it offers fast and efficient access to individual
469 * elements in any order and saves the user from worrying about
470 * memory and size allocation. Subscripting ( @c [] ) access is
471 * also provided as with C-style arrays.
473 template<typename _Alloc>
474 class vector<bool, _Alloc> : protected _Bvector_base<_Alloc>
476 typedef _Bvector_base<_Alloc> _Base;
478 #ifdef __GXX_EXPERIMENTAL_CXX0X__
479 template<typename> friend class hash;
483 typedef bool value_type;
484 typedef size_t size_type;
485 typedef ptrdiff_t difference_type;
486 typedef _Bit_reference reference;
487 typedef bool const_reference;
488 typedef _Bit_reference* pointer;
489 typedef const bool* const_pointer;
490 typedef _Bit_iterator iterator;
491 typedef _Bit_const_iterator const_iterator;
492 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
493 typedef std::reverse_iterator<iterator> reverse_iterator;
494 typedef _Alloc allocator_type;
496 allocator_type get_allocator() const
497 { return _Base::get_allocator(); }
500 using _Base::_M_allocate;
501 using _Base::_M_deallocate;
502 using _Base::_M_get_Bit_allocator;
509 vector(const allocator_type& __a)
513 vector(size_type __n, const bool& __value = bool(),
514 const allocator_type& __a = allocator_type())
518 std::fill(this->_M_impl._M_start._M_p, this->_M_impl._M_end_of_storage,
522 vector(const vector& __x)
523 : _Base(__x._M_get_Bit_allocator())
525 _M_initialize(__x.size());
526 _M_copy_aligned(__x.begin(), __x.end(), this->_M_impl._M_start);
529 #ifdef __GXX_EXPERIMENTAL_CXX0X__
531 : _Base(std::move(__x)) { }
533 vector(initializer_list<bool> __l,
534 const allocator_type& __a = allocator_type())
537 _M_initialize_range(__l.begin(), __l.end(),
538 random_access_iterator_tag());
542 template<typename _InputIterator>
543 vector(_InputIterator __first, _InputIterator __last,
544 const allocator_type& __a = allocator_type())
547 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
548 _M_initialize_dispatch(__first, __last, _Integral());
554 operator=(const vector& __x)
558 if (__x.size() > capacity())
560 this->_M_deallocate();
561 _M_initialize(__x.size());
563 this->_M_impl._M_finish = _M_copy_aligned(__x.begin(), __x.end(),
568 #ifdef __GXX_EXPERIMENTAL_CXX0X__
570 operator=(vector&& __x)
580 operator=(initializer_list<bool> __l)
582 this->assign (__l.begin(), __l.end());
587 // assign(), a generalized assignment member function. Two
588 // versions: one that takes a count, and one that takes a range.
589 // The range version is a member template, so we dispatch on whether
590 // or not the type is an integer.
592 assign(size_type __n, const bool& __x)
593 { _M_fill_assign(__n, __x); }
595 template<typename _InputIterator>
597 assign(_InputIterator __first, _InputIterator __last)
599 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
600 _M_assign_dispatch(__first, __last, _Integral());
603 #ifdef __GXX_EXPERIMENTAL_CXX0X__
605 assign(initializer_list<bool> __l)
606 { this->assign(__l.begin(), __l.end()); }
611 { return this->_M_impl._M_start; }
615 { return this->_M_impl._M_start; }
619 { return this->_M_impl._M_finish; }
623 { return this->_M_impl._M_finish; }
627 { return reverse_iterator(end()); }
629 const_reverse_iterator
631 { return const_reverse_iterator(end()); }
635 { return reverse_iterator(begin()); }
637 const_reverse_iterator
639 { return const_reverse_iterator(begin()); }
641 #ifdef __GXX_EXPERIMENTAL_CXX0X__
644 { return this->_M_impl._M_start; }
648 { return this->_M_impl._M_finish; }
650 const_reverse_iterator
652 { return const_reverse_iterator(end()); }
654 const_reverse_iterator
656 { return const_reverse_iterator(begin()); }
661 { return size_type(end() - begin()); }
666 const size_type __isize =
667 __gnu_cxx::__numeric_traits<difference_type>::__max
668 - int(_S_word_bit) + 1;
669 const size_type __asize = _M_get_Bit_allocator().max_size();
670 return (__asize <= __isize / int(_S_word_bit)
671 ? __asize * int(_S_word_bit) : __isize);
676 { return size_type(const_iterator(this->_M_impl._M_end_of_storage, 0)
681 { return begin() == end(); }
684 operator[](size_type __n)
686 return *iterator(this->_M_impl._M_start._M_p
687 + __n / int(_S_word_bit), __n % int(_S_word_bit));
691 operator[](size_type __n) const
693 return *const_iterator(this->_M_impl._M_start._M_p
694 + __n / int(_S_word_bit), __n % int(_S_word_bit));
699 _M_range_check(size_type __n) const
701 if (__n >= this->size())
702 __throw_out_of_range(__N("vector<bool>::_M_range_check"));
708 { _M_range_check(__n); return (*this)[__n]; }
711 at(size_type __n) const
712 { _M_range_check(__n); return (*this)[__n]; }
715 reserve(size_type __n);
727 { return *(end() - 1); }
731 { return *(end() - 1); }
733 // _GLIBCXX_RESOLVE_LIB_DEFECTS
734 // DR 464. Suggestion for new member functions in standard containers.
735 // N.B. DR 464 says nothing about vector<bool> but we need something
736 // here due to the way we are implementing DR 464 in the debug-mode
744 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage)
745 *this->_M_impl._M_finish++ = __x;
747 _M_insert_aux(end(), __x);
753 std::swap(this->_M_impl._M_start, __x._M_impl._M_start);
754 std::swap(this->_M_impl._M_finish, __x._M_impl._M_finish);
755 std::swap(this->_M_impl._M_end_of_storage,
756 __x._M_impl._M_end_of_storage);
758 // _GLIBCXX_RESOLVE_LIB_DEFECTS
759 // 431. Swapping containers with unequal allocators.
760 std::__alloc_swap<typename _Base::_Bit_alloc_type>::
761 _S_do_it(_M_get_Bit_allocator(), __x._M_get_Bit_allocator());
764 // [23.2.5]/1, third-to-last entry in synopsis listing
766 swap(reference __x, reference __y)
774 insert(iterator __position, const bool& __x = bool())
776 const difference_type __n = __position - begin();
777 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage
778 && __position == end())
779 *this->_M_impl._M_finish++ = __x;
781 _M_insert_aux(__position, __x);
782 return begin() + __n;
785 template<typename _InputIterator>
787 insert(iterator __position,
788 _InputIterator __first, _InputIterator __last)
790 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
791 _M_insert_dispatch(__position, __first, __last, _Integral());
795 insert(iterator __position, size_type __n, const bool& __x)
796 { _M_fill_insert(__position, __n, __x); }
798 #ifdef __GXX_EXPERIMENTAL_CXX0X__
799 void insert(iterator __p, initializer_list<bool> __l)
800 { this->insert(__p, __l.begin(), __l.end()); }
805 { --this->_M_impl._M_finish; }
808 erase(iterator __position)
810 if (__position + 1 != end())
811 std::copy(__position + 1, end(), __position);
812 --this->_M_impl._M_finish;
817 erase(iterator __first, iterator __last)
819 _M_erase_at_end(std::copy(__last, end(), __first));
824 resize(size_type __new_size, bool __x = bool())
826 if (__new_size < size())
827 _M_erase_at_end(begin() + difference_type(__new_size));
829 insert(end(), __new_size - size(), __x);
832 #ifdef __GXX_EXPERIMENTAL_CXX0X__
835 { std::__shrink_to_fit<vector>::_S_do_it(*this); }
841 for (_Bit_type * __p = this->_M_impl._M_start._M_p;
842 __p != this->_M_impl._M_end_of_storage; ++__p)
848 { _M_erase_at_end(begin()); }
852 // Precondition: __first._M_offset == 0 && __result._M_offset == 0.
854 _M_copy_aligned(const_iterator __first, const_iterator __last,
857 _Bit_type* __q = std::copy(__first._M_p, __last._M_p, __result._M_p);
858 return std::copy(const_iterator(__last._M_p, 0), __last,
863 _M_initialize(size_type __n)
865 _Bit_type* __q = this->_M_allocate(__n);
866 this->_M_impl._M_end_of_storage = (__q
867 + ((__n + int(_S_word_bit) - 1)
868 / int(_S_word_bit)));
869 this->_M_impl._M_start = iterator(__q, 0);
870 this->_M_impl._M_finish = this->_M_impl._M_start + difference_type(__n);
873 // Check whether it's an integral type. If so, it's not an iterator.
875 // _GLIBCXX_RESOLVE_LIB_DEFECTS
876 // 438. Ambiguity in the "do the right thing" clause
877 template<typename _Integer>
879 _M_initialize_dispatch(_Integer __n, _Integer __x, __true_type)
881 _M_initialize(static_cast<size_type>(__n));
882 std::fill(this->_M_impl._M_start._M_p,
883 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
886 template<typename _InputIterator>
888 _M_initialize_dispatch(_InputIterator __first, _InputIterator __last,
890 { _M_initialize_range(__first, __last,
891 std::__iterator_category(__first)); }
893 template<typename _InputIterator>
895 _M_initialize_range(_InputIterator __first, _InputIterator __last,
896 std::input_iterator_tag)
898 for (; __first != __last; ++__first)
902 template<typename _ForwardIterator>
904 _M_initialize_range(_ForwardIterator __first, _ForwardIterator __last,
905 std::forward_iterator_tag)
907 const size_type __n = std::distance(__first, __last);
909 std::copy(__first, __last, this->_M_impl._M_start);
912 // _GLIBCXX_RESOLVE_LIB_DEFECTS
913 // 438. Ambiguity in the "do the right thing" clause
914 template<typename _Integer>
916 _M_assign_dispatch(_Integer __n, _Integer __val, __true_type)
917 { _M_fill_assign(__n, __val); }
919 template<class _InputIterator>
921 _M_assign_dispatch(_InputIterator __first, _InputIterator __last,
923 { _M_assign_aux(__first, __last, std::__iterator_category(__first)); }
926 _M_fill_assign(size_t __n, bool __x)
930 std::fill(this->_M_impl._M_start._M_p,
931 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
932 insert(end(), __n - size(), __x);
936 _M_erase_at_end(begin() + __n);
937 std::fill(this->_M_impl._M_start._M_p,
938 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
942 template<typename _InputIterator>
944 _M_assign_aux(_InputIterator __first, _InputIterator __last,
945 std::input_iterator_tag)
947 iterator __cur = begin();
948 for (; __first != __last && __cur != end(); ++__cur, ++__first)
950 if (__first == __last)
951 _M_erase_at_end(__cur);
953 insert(end(), __first, __last);
956 template<typename _ForwardIterator>
958 _M_assign_aux(_ForwardIterator __first, _ForwardIterator __last,
959 std::forward_iterator_tag)
961 const size_type __len = std::distance(__first, __last);
963 _M_erase_at_end(std::copy(__first, __last, begin()));
966 _ForwardIterator __mid = __first;
967 std::advance(__mid, size());
968 std::copy(__first, __mid, begin());
969 insert(end(), __mid, __last);
973 // Check whether it's an integral type. If so, it's not an iterator.
975 // _GLIBCXX_RESOLVE_LIB_DEFECTS
976 // 438. Ambiguity in the "do the right thing" clause
977 template<typename _Integer>
979 _M_insert_dispatch(iterator __pos, _Integer __n, _Integer __x,
981 { _M_fill_insert(__pos, __n, __x); }
983 template<typename _InputIterator>
985 _M_insert_dispatch(iterator __pos,
986 _InputIterator __first, _InputIterator __last,
988 { _M_insert_range(__pos, __first, __last,
989 std::__iterator_category(__first)); }
992 _M_fill_insert(iterator __position, size_type __n, bool __x);
994 template<typename _InputIterator>
996 _M_insert_range(iterator __pos, _InputIterator __first,
997 _InputIterator __last, std::input_iterator_tag)
999 for (; __first != __last; ++__first)
1001 __pos = insert(__pos, *__first);
1006 template<typename _ForwardIterator>
1008 _M_insert_range(iterator __position, _ForwardIterator __first,
1009 _ForwardIterator __last, std::forward_iterator_tag);
1012 _M_insert_aux(iterator __position, bool __x);
1015 _M_check_len(size_type __n, const char* __s) const
1017 if (max_size() - size() < __n)
1018 __throw_length_error(__N(__s));
1020 const size_type __len = size() + std::max(size(), __n);
1021 return (__len < size() || __len > max_size()) ? max_size() : __len;
1025 _M_erase_at_end(iterator __pos)
1026 { this->_M_impl._M_finish = __pos; }
1029 _GLIBCXX_END_NESTED_NAMESPACE
1031 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1033 #include <bits/functional_hash.h>
1035 _GLIBCXX_BEGIN_NAMESPACE(std)
1038 /// std::hash specialization for vector<bool>.
1039 template<typename _Alloc>
1040 struct hash<_GLIBCXX_STD_D::vector<bool, _Alloc>>
1041 : public __hash_base<size_t, _GLIBCXX_STD_D::vector<bool, _Alloc>>
1044 operator()(const _GLIBCXX_STD_D::vector<bool, _Alloc>& __b) const;
1047 _GLIBCXX_END_NAMESPACE
1049 #endif // __GXX_EXPERIMENTAL_CXX0X__