1 // vector<bool> specialization -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
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 stl_bvector.h
53 * This is an internal header file, included by other library headers.
54 * You should not attempt to use it directly.
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;
479 typedef bool value_type;
480 typedef size_t size_type;
481 typedef ptrdiff_t difference_type;
482 typedef _Bit_reference reference;
483 typedef bool const_reference;
484 typedef _Bit_reference* pointer;
485 typedef const bool* const_pointer;
486 typedef _Bit_iterator iterator;
487 typedef _Bit_const_iterator const_iterator;
488 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
489 typedef std::reverse_iterator<iterator> reverse_iterator;
490 typedef _Alloc allocator_type;
492 allocator_type get_allocator() const
493 { return _Base::get_allocator(); }
496 using _Base::_M_allocate;
497 using _Base::_M_deallocate;
498 using _Base::_M_get_Bit_allocator;
505 vector(const allocator_type& __a)
509 vector(size_type __n, const bool& __value = bool(),
510 const allocator_type& __a = allocator_type())
514 std::fill(this->_M_impl._M_start._M_p, this->_M_impl._M_end_of_storage,
518 vector(const vector& __x)
519 : _Base(__x._M_get_Bit_allocator())
521 _M_initialize(__x.size());
522 _M_copy_aligned(__x.begin(), __x.end(), this->_M_impl._M_start);
525 #ifdef __GXX_EXPERIMENTAL_CXX0X__
527 : _Base(std::forward<_Base>(__x)) { }
529 vector(initializer_list<bool> __l,
530 const allocator_type& __a = allocator_type())
533 _M_initialize_range(__l.begin(), __l.end(),
534 random_access_iterator_tag());
538 template<typename _InputIterator>
539 vector(_InputIterator __first, _InputIterator __last,
540 const allocator_type& __a = allocator_type())
543 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
544 _M_initialize_dispatch(__first, __last, _Integral());
550 operator=(const vector& __x)
554 if (__x.size() > capacity())
556 this->_M_deallocate();
557 _M_initialize(__x.size());
559 this->_M_impl._M_finish = _M_copy_aligned(__x.begin(), __x.end(),
564 #ifdef __GXX_EXPERIMENTAL_CXX0X__
566 operator=(vector&& __x)
575 operator=(initializer_list<bool> __l)
577 this->assign (__l.begin(), __l.end());
582 // assign(), a generalized assignment member function. Two
583 // versions: one that takes a count, and one that takes a range.
584 // The range version is a member template, so we dispatch on whether
585 // or not the type is an integer.
587 assign(size_type __n, const bool& __x)
588 { _M_fill_assign(__n, __x); }
590 template<typename _InputIterator>
592 assign(_InputIterator __first, _InputIterator __last)
594 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
595 _M_assign_dispatch(__first, __last, _Integral());
598 #ifdef __GXX_EXPERIMENTAL_CXX0X__
600 assign(initializer_list<bool> __l)
601 { this->assign(__l.begin(), __l.end()); }
606 { return this->_M_impl._M_start; }
610 { return this->_M_impl._M_start; }
614 { return this->_M_impl._M_finish; }
618 { return this->_M_impl._M_finish; }
622 { return reverse_iterator(end()); }
624 const_reverse_iterator
626 { return const_reverse_iterator(end()); }
630 { return reverse_iterator(begin()); }
632 const_reverse_iterator
634 { return const_reverse_iterator(begin()); }
636 #ifdef __GXX_EXPERIMENTAL_CXX0X__
639 { return this->_M_impl._M_start; }
643 { return this->_M_impl._M_finish; }
645 const_reverse_iterator
647 { return const_reverse_iterator(end()); }
649 const_reverse_iterator
651 { return const_reverse_iterator(begin()); }
656 { return size_type(end() - begin()); }
661 const size_type __isize =
662 __gnu_cxx::__numeric_traits<difference_type>::__max
663 - int(_S_word_bit) + 1;
664 const size_type __asize = _M_get_Bit_allocator().max_size();
665 return (__asize <= __isize / int(_S_word_bit)
666 ? __asize * int(_S_word_bit) : __isize);
671 { return size_type(const_iterator(this->_M_impl._M_end_of_storage, 0)
676 { return begin() == end(); }
679 operator[](size_type __n)
681 return *iterator(this->_M_impl._M_start._M_p
682 + __n / int(_S_word_bit), __n % int(_S_word_bit));
686 operator[](size_type __n) const
688 return *const_iterator(this->_M_impl._M_start._M_p
689 + __n / int(_S_word_bit), __n % int(_S_word_bit));
694 _M_range_check(size_type __n) const
696 if (__n >= this->size())
697 __throw_out_of_range(__N("vector<bool>::_M_range_check"));
703 { _M_range_check(__n); return (*this)[__n]; }
706 at(size_type __n) const
707 { _M_range_check(__n); return (*this)[__n]; }
710 reserve(size_type __n);
722 { return *(end() - 1); }
726 { return *(end() - 1); }
728 // _GLIBCXX_RESOLVE_LIB_DEFECTS
729 // DR 464. Suggestion for new member functions in standard containers.
730 // N.B. DR 464 says nothing about vector<bool> but we need something
731 // here due to the way we are implementing DR 464 in the debug-mode
739 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage)
740 *this->_M_impl._M_finish++ = __x;
742 _M_insert_aux(end(), __x);
746 #ifdef __GXX_EXPERIMENTAL_CXX0X__
752 std::swap(this->_M_impl._M_start, __x._M_impl._M_start);
753 std::swap(this->_M_impl._M_finish, __x._M_impl._M_finish);
754 std::swap(this->_M_impl._M_end_of_storage,
755 __x._M_impl._M_end_of_storage);
757 // _GLIBCXX_RESOLVE_LIB_DEFECTS
758 // 431. Swapping containers with unequal allocators.
759 std::__alloc_swap<typename _Base::_Bit_alloc_type>::
760 _S_do_it(_M_get_Bit_allocator(), __x._M_get_Bit_allocator());
763 // [23.2.5]/1, third-to-last entry in synopsis listing
765 swap(reference __x, reference __y)
773 insert(iterator __position, const bool& __x = bool())
775 const difference_type __n = __position - begin();
776 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage
777 && __position == end())
778 *this->_M_impl._M_finish++ = __x;
780 _M_insert_aux(__position, __x);
781 return begin() + __n;
784 template<typename _InputIterator>
786 insert(iterator __position,
787 _InputIterator __first, _InputIterator __last)
789 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
790 _M_insert_dispatch(__position, __first, __last, _Integral());
794 insert(iterator __position, size_type __n, const bool& __x)
795 { _M_fill_insert(__position, __n, __x); }
797 #ifdef __GXX_EXPERIMENTAL_CXX0X__
798 void insert(iterator __p, initializer_list<bool> __l)
799 { this->insert(__p, __l.begin(), __l.end()); }
804 { --this->_M_impl._M_finish; }
807 erase(iterator __position)
809 if (__position + 1 != end())
810 std::copy(__position + 1, end(), __position);
811 --this->_M_impl._M_finish;
816 erase(iterator __first, iterator __last)
818 _M_erase_at_end(std::copy(__last, end(), __first));
823 resize(size_type __new_size, bool __x = bool())
825 if (__new_size < size())
826 _M_erase_at_end(begin() + difference_type(__new_size));
828 insert(end(), __new_size - size(), __x);
834 for (_Bit_type * __p = this->_M_impl._M_start._M_p;
835 __p != this->_M_impl._M_end_of_storage; ++__p)
841 { _M_erase_at_end(begin()); }
845 // Precondition: __first._M_offset == 0 && __result._M_offset == 0.
847 _M_copy_aligned(const_iterator __first, const_iterator __last,
850 _Bit_type* __q = std::copy(__first._M_p, __last._M_p, __result._M_p);
851 return std::copy(const_iterator(__last._M_p, 0), __last,
856 _M_initialize(size_type __n)
858 _Bit_type* __q = this->_M_allocate(__n);
859 this->_M_impl._M_end_of_storage = (__q
860 + ((__n + int(_S_word_bit) - 1)
861 / int(_S_word_bit)));
862 this->_M_impl._M_start = iterator(__q, 0);
863 this->_M_impl._M_finish = this->_M_impl._M_start + difference_type(__n);
866 // Check whether it's an integral type. If so, it's not an iterator.
868 // _GLIBCXX_RESOLVE_LIB_DEFECTS
869 // 438. Ambiguity in the "do the right thing" clause
870 template<typename _Integer>
872 _M_initialize_dispatch(_Integer __n, _Integer __x, __true_type)
874 _M_initialize(static_cast<size_type>(__n));
875 std::fill(this->_M_impl._M_start._M_p,
876 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
879 template<typename _InputIterator>
881 _M_initialize_dispatch(_InputIterator __first, _InputIterator __last,
883 { _M_initialize_range(__first, __last,
884 std::__iterator_category(__first)); }
886 template<typename _InputIterator>
888 _M_initialize_range(_InputIterator __first, _InputIterator __last,
889 std::input_iterator_tag)
891 for (; __first != __last; ++__first)
895 template<typename _ForwardIterator>
897 _M_initialize_range(_ForwardIterator __first, _ForwardIterator __last,
898 std::forward_iterator_tag)
900 const size_type __n = std::distance(__first, __last);
902 std::copy(__first, __last, this->_M_impl._M_start);
905 // _GLIBCXX_RESOLVE_LIB_DEFECTS
906 // 438. Ambiguity in the "do the right thing" clause
907 template<typename _Integer>
909 _M_assign_dispatch(_Integer __n, _Integer __val, __true_type)
910 { _M_fill_assign(__n, __val); }
912 template<class _InputIterator>
914 _M_assign_dispatch(_InputIterator __first, _InputIterator __last,
916 { _M_assign_aux(__first, __last, std::__iterator_category(__first)); }
919 _M_fill_assign(size_t __n, bool __x)
923 std::fill(this->_M_impl._M_start._M_p,
924 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
925 insert(end(), __n - size(), __x);
929 _M_erase_at_end(begin() + __n);
930 std::fill(this->_M_impl._M_start._M_p,
931 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
935 template<typename _InputIterator>
937 _M_assign_aux(_InputIterator __first, _InputIterator __last,
938 std::input_iterator_tag)
940 iterator __cur = begin();
941 for (; __first != __last && __cur != end(); ++__cur, ++__first)
943 if (__first == __last)
944 _M_erase_at_end(__cur);
946 insert(end(), __first, __last);
949 template<typename _ForwardIterator>
951 _M_assign_aux(_ForwardIterator __first, _ForwardIterator __last,
952 std::forward_iterator_tag)
954 const size_type __len = std::distance(__first, __last);
956 _M_erase_at_end(std::copy(__first, __last, begin()));
959 _ForwardIterator __mid = __first;
960 std::advance(__mid, size());
961 std::copy(__first, __mid, begin());
962 insert(end(), __mid, __last);
966 // Check whether it's an integral type. If so, it's not an iterator.
968 // _GLIBCXX_RESOLVE_LIB_DEFECTS
969 // 438. Ambiguity in the "do the right thing" clause
970 template<typename _Integer>
972 _M_insert_dispatch(iterator __pos, _Integer __n, _Integer __x,
974 { _M_fill_insert(__pos, __n, __x); }
976 template<typename _InputIterator>
978 _M_insert_dispatch(iterator __pos,
979 _InputIterator __first, _InputIterator __last,
981 { _M_insert_range(__pos, __first, __last,
982 std::__iterator_category(__first)); }
985 _M_fill_insert(iterator __position, size_type __n, bool __x);
987 template<typename _InputIterator>
989 _M_insert_range(iterator __pos, _InputIterator __first,
990 _InputIterator __last, std::input_iterator_tag)
992 for (; __first != __last; ++__first)
994 __pos = insert(__pos, *__first);
999 template<typename _ForwardIterator>
1001 _M_insert_range(iterator __position, _ForwardIterator __first,
1002 _ForwardIterator __last, std::forward_iterator_tag);
1005 _M_insert_aux(iterator __position, bool __x);
1008 _M_check_len(size_type __n, const char* __s) const
1010 if (max_size() - size() < __n)
1011 __throw_length_error(__N(__s));
1013 const size_type __len = size() + std::max(size(), __n);
1014 return (__len < size() || __len > max_size()) ? max_size() : __len;
1018 _M_erase_at_end(iterator __pos)
1019 { this->_M_impl._M_finish = __pos; }
1022 _GLIBCXX_END_NESTED_NAMESPACE