1 // vector<bool> specialization -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007
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 2, 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 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
34 * Hewlett-Packard Company
36 * Permission to use, copy, modify, distribute and sell this software
37 * and its documentation for any purpose is hereby granted without fee,
38 * provided that the above copyright notice appear in all copies and
39 * that both that copyright notice and this permission notice appear
40 * in supporting documentation. Hewlett-Packard Company makes no
41 * representations about the suitability of this software for any
42 * purpose. It is provided "as is" without express or implied warranty.
45 * Copyright (c) 1996-1999
46 * Silicon Graphics Computer Systems, Inc.
48 * Permission to use, copy, modify, distribute and sell this software
49 * and its documentation for any purpose is hereby granted without fee,
50 * provided that the above copyright notice appear in all copies and
51 * that both that copyright notice and this permission notice appear
52 * in supporting documentation. Silicon Graphics makes no
53 * representations about the suitability of this software for any
54 * purpose. It is provided "as is" without express or implied warranty.
57 /** @file stl_bvector.h
58 * This is an internal header file, included by other library headers.
59 * You should not attempt to use it directly.
62 #ifndef _STL_BVECTOR_H
63 #define _STL_BVECTOR_H 1
65 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD)
67 typedef unsigned long _Bit_type;
68 enum { _S_word_bit = int(__CHAR_BIT__ * sizeof(_Bit_type)) };
75 _Bit_reference(_Bit_type * __x, _Bit_type __y)
76 : _M_p(__x), _M_mask(__y) { }
78 _Bit_reference() : _M_p(0), _M_mask(0) { }
81 { return !!(*_M_p & _M_mask); }
94 operator=(const _Bit_reference& __x)
95 { return *this = bool(__x); }
98 operator==(const _Bit_reference& __x) const
99 { return bool(*this) == bool(__x); }
102 operator<(const _Bit_reference& __x) const
103 { return !bool(*this) && bool(__x); }
107 { *_M_p ^= _M_mask; }
110 struct _Bit_iterator_base
111 : public std::iterator<std::random_access_iterator_tag, bool>
114 unsigned int _M_offset;
116 _Bit_iterator_base(_Bit_type * __x, unsigned int __y)
117 : _M_p(__x), _M_offset(__y) { }
122 if (_M_offset++ == int(_S_word_bit) - 1)
132 if (_M_offset-- == 0)
134 _M_offset = int(_S_word_bit) - 1;
140 _M_incr(ptrdiff_t __i)
142 difference_type __n = __i + _M_offset;
143 _M_p += __n / int(_S_word_bit);
144 __n = __n % int(_S_word_bit);
147 __n += int(_S_word_bit);
150 _M_offset = static_cast<unsigned int>(__n);
154 operator==(const _Bit_iterator_base& __i) const
155 { return _M_p == __i._M_p && _M_offset == __i._M_offset; }
158 operator<(const _Bit_iterator_base& __i) const
160 return _M_p < __i._M_p
161 || (_M_p == __i._M_p && _M_offset < __i._M_offset);
165 operator!=(const _Bit_iterator_base& __i) const
166 { return !(*this == __i); }
169 operator>(const _Bit_iterator_base& __i) const
170 { return __i < *this; }
173 operator<=(const _Bit_iterator_base& __i) const
174 { return !(__i < *this); }
177 operator>=(const _Bit_iterator_base& __i) const
178 { return !(*this < __i); }
182 operator-(const _Bit_iterator_base& __x, const _Bit_iterator_base& __y)
184 return (int(_S_word_bit) * (__x._M_p - __y._M_p)
185 + __x._M_offset - __y._M_offset);
188 struct _Bit_iterator : public _Bit_iterator_base
190 typedef _Bit_reference reference;
191 typedef _Bit_reference* pointer;
192 typedef _Bit_iterator iterator;
194 _Bit_iterator() : _Bit_iterator_base(0, 0) { }
196 _Bit_iterator(_Bit_type * __x, unsigned int __y)
197 : _Bit_iterator_base(__x, __y) { }
201 { return reference(_M_p, 1UL << _M_offset); }
213 iterator __tmp = *this;
228 iterator __tmp = *this;
234 operator+=(difference_type __i)
241 operator-=(difference_type __i)
248 operator+(difference_type __i) const
250 iterator __tmp = *this;
255 operator-(difference_type __i) const
257 iterator __tmp = *this;
262 operator[](difference_type __i) const
263 { return *(*this + __i); }
267 operator+(ptrdiff_t __n, const _Bit_iterator& __x)
268 { return __x + __n; }
270 struct _Bit_const_iterator : public _Bit_iterator_base
272 typedef bool reference;
273 typedef bool const_reference;
274 typedef const bool* pointer;
275 typedef _Bit_const_iterator const_iterator;
277 _Bit_const_iterator() : _Bit_iterator_base(0, 0) { }
279 _Bit_const_iterator(_Bit_type * __x, unsigned int __y)
280 : _Bit_iterator_base(__x, __y) { }
282 _Bit_const_iterator(const _Bit_iterator& __x)
283 : _Bit_iterator_base(__x._M_p, __x._M_offset) { }
287 { return _Bit_reference(_M_p, 1UL << _M_offset); }
299 const_iterator __tmp = *this;
314 const_iterator __tmp = *this;
320 operator+=(difference_type __i)
327 operator-=(difference_type __i)
334 operator+(difference_type __i) const
336 const_iterator __tmp = *this;
341 operator-(difference_type __i) const
343 const_iterator __tmp = *this;
348 operator[](difference_type __i) const
349 { return *(*this + __i); }
352 inline _Bit_const_iterator
353 operator+(ptrdiff_t __n, const _Bit_const_iterator& __x)
354 { return __x + __n; }
357 __fill_bvector(_Bit_iterator __first, _Bit_iterator __last, bool __x)
359 for (; __first != __last; ++__first)
364 fill(_Bit_iterator __first, _Bit_iterator __last, const bool& __x)
366 if (__first._M_p != __last._M_p)
368 std::fill(__first._M_p + 1, __last._M_p, __x ? ~0 : 0);
369 __fill_bvector(__first, _Bit_iterator(__first._M_p + 1, 0), __x);
370 __fill_bvector(_Bit_iterator(__last._M_p, 0), __last, __x);
373 __fill_bvector(__first, __last, __x);
376 template<typename _Alloc>
379 typedef typename _Alloc::template rebind<_Bit_type>::other
383 : public _Bit_alloc_type
385 _Bit_iterator _M_start;
386 _Bit_iterator _M_finish;
387 _Bit_type* _M_end_of_storage;
388 _Bvector_impl(const _Bit_alloc_type& __a)
389 : _Bit_alloc_type(__a), _M_start(), _M_finish(), _M_end_of_storage(0)
394 typedef _Alloc allocator_type;
397 _M_get_Bit_allocator()
398 { return *static_cast<_Bit_alloc_type*>(&this->_M_impl); }
400 const _Bit_alloc_type&
401 _M_get_Bit_allocator() const
402 { return *static_cast<const _Bit_alloc_type*>(&this->_M_impl); }
405 get_allocator() const
406 { return allocator_type(_M_get_Bit_allocator()); }
408 _Bvector_base(const allocator_type& __a) : _M_impl(__a) { }
411 { this->_M_deallocate(); }
414 _Bvector_impl _M_impl;
417 _M_allocate(size_t __n)
418 { return _M_impl.allocate((__n + int(_S_word_bit) - 1)
419 / int(_S_word_bit)); }
424 if (_M_impl._M_start._M_p)
425 _M_impl.deallocate(_M_impl._M_start._M_p,
426 _M_impl._M_end_of_storage - _M_impl._M_start._M_p);
430 _GLIBCXX_END_NESTED_NAMESPACE
432 // Declare a partial specialization of vector<T, Alloc>.
433 #include <bits/stl_vector.h>
435 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std, _GLIBCXX_STD)
438 * @brief A specialization of vector for booleans which offers fixed time
439 * access to individual elements in any order.
441 * Note that vector<bool> does not actually meet the requirements for being
442 * a container. This is because the reference and pointer types are not
443 * really references and pointers to bool. See DR96 for details. @see
444 * vector for function documentation.
446 * @ingroup Containers
449 * In some terminology a %vector can be described as a dynamic
450 * C-style array, it offers fast and efficient access to individual
451 * elements in any order and saves the user from worrying about
452 * memory and size allocation. Subscripting ( @c [] ) access is
453 * also provided as with C-style arrays.
455 template<typename _Alloc>
456 class vector<bool, _Alloc> : protected _Bvector_base<_Alloc>
458 typedef _Bvector_base<_Alloc> _Base;
461 typedef bool value_type;
462 typedef size_t size_type;
463 typedef ptrdiff_t difference_type;
464 typedef _Bit_reference reference;
465 typedef bool const_reference;
466 typedef _Bit_reference* pointer;
467 typedef const bool* const_pointer;
468 typedef _Bit_iterator iterator;
469 typedef _Bit_const_iterator const_iterator;
470 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
471 typedef std::reverse_iterator<iterator> reverse_iterator;
472 typedef _Alloc allocator_type;
474 allocator_type get_allocator() const
475 { return _Base::get_allocator(); }
478 using _Base::_M_allocate;
479 using _Base::_M_deallocate;
480 using _Base::_M_get_Bit_allocator;
484 vector(const allocator_type& __a = allocator_type())
488 vector(size_type __n, const bool& __value = bool(),
489 const allocator_type& __a = allocator_type())
493 std::fill(this->_M_impl._M_start._M_p, this->_M_impl._M_end_of_storage,
497 vector(const vector& __x)
498 : _Base(__x._M_get_Bit_allocator())
500 _M_initialize(__x.size());
501 _M_copy_aligned(__x.begin(), __x.end(), this->_M_impl._M_start);
504 template<typename _InputIterator>
505 vector(_InputIterator __first, _InputIterator __last,
506 const allocator_type& __a = allocator_type())
509 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
510 _M_initialize_dispatch(__first, __last, _Integral());
516 operator=(const vector& __x)
520 if (__x.size() > capacity())
522 this->_M_deallocate();
523 _M_initialize(__x.size());
525 this->_M_impl._M_finish = _M_copy_aligned(__x.begin(), __x.end(),
530 // assign(), a generalized assignment member function. Two
531 // versions: one that takes a count, and one that takes a range.
532 // The range version is a member template, so we dispatch on whether
533 // or not the type is an integer.
535 assign(size_type __n, const bool& __x)
536 { _M_fill_assign(__n, __x); }
538 template<typename _InputIterator>
540 assign(_InputIterator __first, _InputIterator __last)
542 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
543 _M_assign_dispatch(__first, __last, _Integral());
548 { return this->_M_impl._M_start; }
552 { return this->_M_impl._M_start; }
556 { return this->_M_impl._M_finish; }
560 { return this->_M_impl._M_finish; }
564 { return reverse_iterator(end()); }
566 const_reverse_iterator
568 { return const_reverse_iterator(end()); }
572 { return reverse_iterator(begin()); }
574 const_reverse_iterator
576 { return const_reverse_iterator(begin()); }
580 { return size_type(end() - begin()); }
585 const size_type __isize =
586 __gnu_cxx::__numeric_traits<difference_type>::__max
587 - int(_S_word_bit) + 1;
588 const size_type __asize = _M_get_Bit_allocator().max_size();
589 return (__asize <= __isize / int(_S_word_bit)
590 ? __asize * int(_S_word_bit) : __isize);
595 { return size_type(const_iterator(this->_M_impl._M_end_of_storage, 0)
600 { return begin() == end(); }
603 operator[](size_type __n)
605 return *iterator(this->_M_impl._M_start._M_p
606 + __n / int(_S_word_bit), __n % int(_S_word_bit));
610 operator[](size_type __n) const
612 return *const_iterator(this->_M_impl._M_start._M_p
613 + __n / int(_S_word_bit), __n % int(_S_word_bit));
618 _M_range_check(size_type __n) const
620 if (__n >= this->size())
621 __throw_out_of_range(__N("vector<bool>::_M_range_check"));
627 { _M_range_check(__n); return (*this)[__n]; }
630 at(size_type __n) const
631 { _M_range_check(__n); return (*this)[__n]; }
634 reserve(size_type __n)
636 if (__n > this->max_size())
637 __throw_length_error(__N("vector::reserve"));
638 if (this->capacity() < __n)
640 _Bit_type* __q = this->_M_allocate(__n);
641 this->_M_impl._M_finish = _M_copy_aligned(begin(), end(),
643 this->_M_deallocate();
644 this->_M_impl._M_start = iterator(__q, 0);
645 this->_M_impl._M_end_of_storage = (__q + (__n + int(_S_word_bit) - 1)
660 { return *(end() - 1); }
664 { return *(end() - 1); }
666 // _GLIBCXX_RESOLVE_LIB_DEFECTS
667 // DR 464. Suggestion for new member functions in standard containers.
668 // N.B. DR 464 says nothing about vector<bool> but we need something
669 // here due to the way we are implementing DR 464 in the debug-mode
677 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage)
678 *this->_M_impl._M_finish++ = __x;
680 _M_insert_aux(end(), __x);
684 swap(vector<bool, _Alloc>& __x)
686 std::swap(this->_M_impl._M_start, __x._M_impl._M_start);
687 std::swap(this->_M_impl._M_finish, __x._M_impl._M_finish);
688 std::swap(this->_M_impl._M_end_of_storage,
689 __x._M_impl._M_end_of_storage);
691 // _GLIBCXX_RESOLVE_LIB_DEFECTS
692 // 431. Swapping containers with unequal allocators.
693 std::__alloc_swap<typename _Base::_Bit_alloc_type>::
694 _S_do_it(_M_get_Bit_allocator(), __x._M_get_Bit_allocator());
697 // [23.2.5]/1, third-to-last entry in synopsis listing
699 swap(reference __x, reference __y)
707 insert(iterator __position, const bool& __x = bool())
709 const difference_type __n = __position - begin();
710 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage
711 && __position == end())
712 *this->_M_impl._M_finish++ = __x;
714 _M_insert_aux(__position, __x);
715 return begin() + __n;
718 template<typename _InputIterator>
720 insert(iterator __position,
721 _InputIterator __first, _InputIterator __last)
723 typedef typename std::__is_integer<_InputIterator>::__type _Integral;
724 _M_insert_dispatch(__position, __first, __last, _Integral());
728 insert(iterator __position, size_type __n, const bool& __x)
729 { _M_fill_insert(__position, __n, __x); }
733 { --this->_M_impl._M_finish; }
736 erase(iterator __position)
738 if (__position + 1 != end())
739 std::copy(__position + 1, end(), __position);
740 --this->_M_impl._M_finish;
745 erase(iterator __first, iterator __last)
747 _M_erase_at_end(std::copy(__last, end(), __first));
752 resize(size_type __new_size, bool __x = bool())
754 if (__new_size < size())
755 _M_erase_at_end(begin() + difference_type(__new_size));
757 insert(end(), __new_size - size(), __x);
763 for (_Bit_type * __p = this->_M_impl._M_start._M_p;
764 __p != this->_M_impl._M_end_of_storage; ++__p)
770 { _M_erase_at_end(begin()); }
774 // Precondition: __first._M_offset == 0 && __result._M_offset == 0.
776 _M_copy_aligned(const_iterator __first, const_iterator __last,
779 _Bit_type* __q = std::copy(__first._M_p, __last._M_p, __result._M_p);
780 return std::copy(const_iterator(__last._M_p, 0), __last,
785 _M_initialize(size_type __n)
787 _Bit_type* __q = this->_M_allocate(__n);
788 this->_M_impl._M_end_of_storage = (__q
789 + ((__n + int(_S_word_bit) - 1)
790 / int(_S_word_bit)));
791 this->_M_impl._M_start = iterator(__q, 0);
792 this->_M_impl._M_finish = this->_M_impl._M_start + difference_type(__n);
795 // Check whether it's an integral type. If so, it's not an iterator.
797 // _GLIBCXX_RESOLVE_LIB_DEFECTS
798 // 438. Ambiguity in the "do the right thing" clause
799 template<typename _Integer>
801 _M_initialize_dispatch(_Integer __n, _Integer __x, __true_type)
803 _M_initialize(static_cast<size_type>(__n));
804 std::fill(this->_M_impl._M_start._M_p,
805 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
808 template<typename _InputIterator>
810 _M_initialize_dispatch(_InputIterator __first, _InputIterator __last,
812 { _M_initialize_range(__first, __last,
813 std::__iterator_category(__first)); }
815 template<typename _InputIterator>
817 _M_initialize_range(_InputIterator __first, _InputIterator __last,
818 std::input_iterator_tag)
820 for (; __first != __last; ++__first)
824 template<typename _ForwardIterator>
826 _M_initialize_range(_ForwardIterator __first, _ForwardIterator __last,
827 std::forward_iterator_tag)
829 const size_type __n = std::distance(__first, __last);
831 std::copy(__first, __last, this->_M_impl._M_start);
834 // _GLIBCXX_RESOLVE_LIB_DEFECTS
835 // 438. Ambiguity in the "do the right thing" clause
836 template<typename _Integer>
838 _M_assign_dispatch(_Integer __n, _Integer __val, __true_type)
839 { _M_fill_assign(__n, __val); }
841 template<class _InputIterator>
843 _M_assign_dispatch(_InputIterator __first, _InputIterator __last,
845 { _M_assign_aux(__first, __last, std::__iterator_category(__first)); }
848 _M_fill_assign(size_t __n, bool __x)
852 std::fill(this->_M_impl._M_start._M_p,
853 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
854 insert(end(), __n - size(), __x);
858 _M_erase_at_end(begin() + __n);
859 std::fill(this->_M_impl._M_start._M_p,
860 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
864 template<typename _InputIterator>
866 _M_assign_aux(_InputIterator __first, _InputIterator __last,
867 std::input_iterator_tag)
869 iterator __cur = begin();
870 for (; __first != __last && __cur != end(); ++__cur, ++__first)
872 if (__first == __last)
873 _M_erase_at_end(__cur);
875 insert(end(), __first, __last);
878 template<typename _ForwardIterator>
880 _M_assign_aux(_ForwardIterator __first, _ForwardIterator __last,
881 std::forward_iterator_tag)
883 const size_type __len = std::distance(__first, __last);
885 _M_erase_at_end(std::copy(__first, __last, begin()));
888 _ForwardIterator __mid = __first;
889 std::advance(__mid, size());
890 std::copy(__first, __mid, begin());
891 insert(end(), __mid, __last);
895 // Check whether it's an integral type. If so, it's not an iterator.
897 // _GLIBCXX_RESOLVE_LIB_DEFECTS
898 // 438. Ambiguity in the "do the right thing" clause
899 template<typename _Integer>
901 _M_insert_dispatch(iterator __pos, _Integer __n, _Integer __x,
903 { _M_fill_insert(__pos, __n, __x); }
905 template<typename _InputIterator>
907 _M_insert_dispatch(iterator __pos,
908 _InputIterator __first, _InputIterator __last,
910 { _M_insert_range(__pos, __first, __last,
911 std::__iterator_category(__first)); }
914 _M_fill_insert(iterator __position, size_type __n, bool __x);
916 template<typename _InputIterator>
918 _M_insert_range(iterator __pos, _InputIterator __first,
919 _InputIterator __last, std::input_iterator_tag)
921 for (; __first != __last; ++__first)
923 __pos = insert(__pos, *__first);
928 template<typename _ForwardIterator>
930 _M_insert_range(iterator __position, _ForwardIterator __first,
931 _ForwardIterator __last, std::forward_iterator_tag);
934 _M_insert_aux(iterator __position, bool __x);
937 _M_check_len(size_type __n, const char* __s) const
939 if (max_size() - size() < __n)
940 __throw_length_error(__N(__s));
942 const size_type __len = size() + std::max(size(), __n);
943 return (__len < size() || __len > max_size()) ? max_size() : __len;
947 _M_erase_at_end(iterator __pos)
948 { this->_M_impl._M_finish = __pos; }
951 _GLIBCXX_END_NESTED_NAMESPACE