1 // vector<bool> specialization -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004 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 2, 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 // You should have received a copy of the GNU General Public License along
17 // with this library; see the file COPYING. If not, write to the Free
18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
21 // As a special exception, you may use this file as part of a free software
22 // library without restriction. Specifically, if other files instantiate
23 // templates or use macros or inline functions from this file, or you compile
24 // this file and link it with other files to produce an executable, this
25 // file does not by itself cause the resulting executable to be covered by
26 // the GNU General Public License. This exception does not however
27 // invalidate any other reasons why the executable file might be covered by
28 // the GNU General Public License.
33 * Hewlett-Packard Company
35 * Permission to use, copy, modify, distribute and sell this software
36 * and its documentation for any purpose is hereby granted without fee,
37 * provided that the above copyright notice appear in all copies and
38 * that both that copyright notice and this permission notice appear
39 * in supporting documentation. Hewlett-Packard Company makes no
40 * representations about the suitability of this software for any
41 * purpose. It is provided "as is" without express or implied warranty.
44 * Copyright (c) 1996-1999
45 * Silicon Graphics Computer Systems, Inc.
47 * Permission to use, copy, modify, distribute and sell this software
48 * and its documentation for any purpose is hereby granted without fee,
49 * provided that the above copyright notice appear in all copies and
50 * that both that copyright notice and this permission notice appear
51 * in supporting documentation. Silicon Graphics makes no
52 * representations about the suitability of this software for any
53 * purpose. It is provided "as is" without express or implied warranty.
56 /** @file stl_bvector.h
57 * This is an internal header file, included by other library headers.
58 * You should not attempt to use it directly.
64 namespace _GLIBCXX_STD
66 typedef unsigned long _Bit_type;
67 enum { _S_word_bit = int(CHAR_BIT * sizeof(_Bit_type)) };
74 _Bit_reference(_Bit_type * __x, _Bit_type __y)
75 : _M_p(__x), _M_mask(__y) { }
77 _Bit_reference() : _M_p(0), _M_mask(0) { }
79 operator bool() const { return !!(*_M_p & _M_mask); }
92 operator=(const _Bit_reference& __x)
93 { return *this = bool(__x); }
96 operator==(const _Bit_reference& __x) const
97 { return bool(*this) == bool(__x); }
100 operator<(const _Bit_reference& __x) const
101 { return !bool(*this) && bool(__x); }
104 flip() { *_M_p ^= _M_mask; }
107 struct _Bit_iterator_base : public iterator<random_access_iterator_tag, bool>
110 unsigned int _M_offset;
112 _Bit_iterator_base(_Bit_type * __x, unsigned int __y)
113 : _M_p(__x), _M_offset(__y) { }
118 if (_M_offset++ == _S_word_bit - 1)
128 if (_M_offset-- == 0)
130 _M_offset = _S_word_bit - 1;
136 _M_incr(ptrdiff_t __i)
138 difference_type __n = __i + _M_offset;
139 _M_p += __n / _S_word_bit;
140 __n = __n % _S_word_bit;
143 _M_offset = static_cast<unsigned int>(__n + _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 _S_word_bit * (__x._M_p - __y._M_p) + __x._M_offset - __y._M_offset;
184 struct _Bit_iterator : public _Bit_iterator_base
186 typedef _Bit_reference reference;
187 typedef _Bit_reference* pointer;
188 typedef _Bit_iterator iterator;
190 _Bit_iterator() : _Bit_iterator_base(0, 0) { }
191 _Bit_iterator(_Bit_type * __x, unsigned int __y)
192 : _Bit_iterator_base(__x, __y) { }
195 operator*() const { return reference(_M_p, 1UL << _M_offset); }
207 iterator __tmp = *this;
222 iterator __tmp = *this;
228 operator+=(difference_type __i)
235 operator-=(difference_type __i)
242 operator+(difference_type __i) const
244 iterator __tmp = *this;
249 operator-(difference_type __i) const
251 iterator __tmp = *this;
256 operator[](difference_type __i)
257 { return *(*this + __i); }
261 operator+(ptrdiff_t __n, const _Bit_iterator& __x) { return __x + __n; }
264 struct _Bit_const_iterator : public _Bit_iterator_base
266 typedef bool reference;
267 typedef bool const_reference;
268 typedef const bool* pointer;
269 typedef _Bit_const_iterator const_iterator;
271 _Bit_const_iterator() : _Bit_iterator_base(0, 0) { }
272 _Bit_const_iterator(_Bit_type * __x, unsigned int __y)
273 : _Bit_iterator_base(__x, __y) { }
274 _Bit_const_iterator(const _Bit_iterator& __x)
275 : _Bit_iterator_base(__x._M_p, __x._M_offset) { }
279 { return _Bit_reference(_M_p, 1UL << _M_offset); }
291 const_iterator __tmp = *this;
306 const_iterator __tmp = *this;
312 operator+=(difference_type __i)
319 operator-=(difference_type __i)
326 operator+(difference_type __i) const {
327 const_iterator __tmp = *this;
332 operator-(difference_type __i) const
334 const_iterator __tmp = *this;
339 operator[](difference_type __i)
340 { return *(*this + __i); }
343 inline _Bit_const_iterator
344 operator+(ptrdiff_t __n, const _Bit_const_iterator& __x)
345 { return __x + __n; }
347 template<class _Alloc>
350 typedef typename _Alloc::template rebind<_Bit_type>::other
353 struct _Bvector_impl : public _Bit_alloc_type
355 _Bit_iterator _M_start;
356 _Bit_iterator _M_finish;
357 _Bit_type* _M_end_of_storage;
358 _Bvector_impl(const _Bit_alloc_type& __a)
359 : _Bit_alloc_type(__a), _M_start(), _M_finish(), _M_end_of_storage(0)
364 typedef _Alloc allocator_type;
367 get_allocator() const
368 { return *static_cast<const _Bit_alloc_type*>(&this->_M_impl); }
370 _Bvector_base(const allocator_type& __a) : _M_impl(__a) { }
372 ~_Bvector_base() { this->_M_deallocate(); }
375 _Bvector_impl _M_impl;
378 _M_allocate(size_t __n)
379 { return _M_impl.allocate((__n + _S_word_bit - 1) / _S_word_bit); }
384 if (_M_impl._M_start._M_p)
385 _M_impl.deallocate(_M_impl._M_start._M_p,
386 _M_impl._M_end_of_storage - _M_impl._M_start._M_p);
391 // Declare a partial specialization of vector<T, Alloc>.
392 #include <bits/stl_vector.h>
394 namespace _GLIBCXX_STD
397 * @brief A specialization of vector for booleans which offers fixed time
398 * access to individual elements in any order.
400 * Note that vector<bool> does not actually meet the requirements for being
401 * a container. This is because the reference and pointer types are not
402 * really references and pointers to bool. See DR96 for details. @see
403 * vector for function documentation.
405 * @ingroup Containers
408 * In some terminology a %vector can be described as a dynamic
409 * C-style array, it offers fast and efficient access to individual
410 * elements in any order and saves the user from worrying about
411 * memory and size allocation. Subscripting ( @c [] ) access is
412 * also provided as with C-style arrays.
414 template<typename _Alloc>
415 class vector<bool, _Alloc> : public _Bvector_base<_Alloc>
418 typedef bool value_type;
419 typedef size_t size_type;
420 typedef ptrdiff_t difference_type;
421 typedef _Bit_reference reference;
422 typedef bool const_reference;
423 typedef _Bit_reference* pointer;
424 typedef const bool* const_pointer;
426 typedef _Bit_iterator iterator;
427 typedef _Bit_const_iterator const_iterator;
429 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
430 typedef std::reverse_iterator<iterator> reverse_iterator;
432 typedef typename _Bvector_base<_Alloc>::allocator_type allocator_type;
434 allocator_type get_allocator() const
435 { return _Bvector_base<_Alloc>::get_allocator(); }
438 using _Bvector_base<_Alloc>::_M_allocate;
439 using _Bvector_base<_Alloc>::_M_deallocate;
442 void _M_initialize(size_type __n)
444 _Bit_type* __q = this->_M_allocate(__n);
445 this->_M_impl._M_end_of_storage = __q
446 + (__n + _S_word_bit - 1) / _S_word_bit;
447 this->_M_impl._M_start = iterator(__q, 0);
448 this->_M_impl._M_finish = this->_M_impl._M_start + difference_type(__n);
451 void _M_insert_aux(iterator __position, bool __x)
453 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage)
455 std::copy_backward(__position, this->_M_impl._M_finish,
456 this->_M_impl._M_finish + 1);
458 ++this->_M_impl._M_finish;
462 const size_type __len = size() ? 2 * size()
463 : static_cast<size_type>(_S_word_bit);
464 _Bit_type * __q = this->_M_allocate(__len);
465 iterator __i = std::copy(begin(), __position, iterator(__q, 0));
467 this->_M_impl._M_finish = std::copy(__position, end(), __i);
468 this->_M_deallocate();
469 this->_M_impl._M_end_of_storage = __q + (__len + _S_word_bit - 1)
471 this->_M_impl._M_start = iterator(__q, 0);
475 template<class _InputIterator>
476 void _M_initialize_range(_InputIterator __first, _InputIterator __last,
479 this->_M_impl._M_start = iterator();
480 this->_M_impl._M_finish = iterator();
481 this->_M_impl._M_end_of_storage = 0;
482 for ( ; __first != __last; ++__first)
486 template<class _ForwardIterator>
487 void _M_initialize_range(_ForwardIterator __first, _ForwardIterator __last,
488 forward_iterator_tag)
490 const size_type __n = std::distance(__first, __last);
492 std::copy(__first, __last, this->_M_impl._M_start);
495 template<class _InputIterator>
496 void _M_insert_range(iterator __pos, _InputIterator __first,
497 _InputIterator __last, input_iterator_tag)
499 for ( ; __first != __last; ++__first)
501 __pos = insert(__pos, *__first);
506 template<class _ForwardIterator>
507 void _M_insert_range(iterator __position, _ForwardIterator __first,
508 _ForwardIterator __last, forward_iterator_tag)
510 if (__first != __last)
512 size_type __n = std::distance(__first, __last);
513 if (capacity() - size() >= __n)
515 std::copy_backward(__position, end(),
516 this->_M_impl._M_finish + difference_type(__n));
517 std::copy(__first, __last, __position);
518 this->_M_impl._M_finish += difference_type(__n);
522 const size_type __len = size() + std::max(size(), __n);
523 _Bit_type * __q = this->_M_allocate(__len);
524 iterator __i = std::copy(begin(), __position, iterator(__q, 0));
525 __i = std::copy(__first, __last, __i);
526 this->_M_impl._M_finish = std::copy(__position, end(), __i);
527 this->_M_deallocate();
528 this->_M_impl._M_end_of_storage = __q + (__len + _S_word_bit - 1)
530 this->_M_impl._M_start = iterator(__q, 0);
537 { return this->_M_impl._M_start; }
539 const_iterator begin() const
540 { return this->_M_impl._M_start; }
543 { return this->_M_impl._M_finish; }
545 const_iterator end() const
546 { return this->_M_impl._M_finish; }
548 reverse_iterator rbegin()
549 { return reverse_iterator(end()); }
551 const_reverse_iterator rbegin() const
552 { return const_reverse_iterator(end()); }
554 reverse_iterator rend()
555 { return reverse_iterator(begin()); }
557 const_reverse_iterator rend() const
558 { return const_reverse_iterator(begin()); }
560 size_type size() const
561 { return size_type(end() - begin()); }
563 size_type max_size() const
564 { return size_type(-1); }
566 size_type capacity() const
567 { return size_type(const_iterator(this->_M_impl._M_end_of_storage, 0)
570 { return begin() == end(); }
572 reference operator[](size_type __n)
573 { return *(begin() + difference_type(__n)); }
575 const_reference operator[](size_type __n) const
576 { return *(begin() + difference_type(__n)); }
578 void _M_range_check(size_type __n) const
580 if (__n >= this->size())
581 __throw_out_of_range(__N("vector<bool>::_M_range_check"));
584 reference at(size_type __n)
585 { _M_range_check(__n); return (*this)[__n]; }
587 const_reference at(size_type __n) const
588 { _M_range_check(__n); return (*this)[__n]; }
590 explicit vector(const allocator_type& __a = allocator_type())
591 : _Bvector_base<_Alloc>(__a) { }
593 vector(size_type __n, bool __value,
594 const allocator_type& __a = allocator_type())
595 : _Bvector_base<_Alloc>(__a)
598 std::fill(this->_M_impl._M_start._M_p, this->_M_impl._M_end_of_storage,
602 explicit vector(size_type __n)
603 : _Bvector_base<_Alloc>(allocator_type())
606 std::fill(this->_M_impl._M_start._M_p,
607 this->_M_impl._M_end_of_storage, 0);
610 vector(const vector& __x) : _Bvector_base<_Alloc>(__x.get_allocator())
612 _M_initialize(__x.size());
613 std::copy(__x.begin(), __x.end(), this->_M_impl._M_start);
616 // Check whether it's an integral type. If so, it's not an iterator.
617 template<class _Integer>
618 void _M_initialize_dispatch(_Integer __n, _Integer __x, __true_type)
621 std::fill(this->_M_impl._M_start._M_p,
622 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
625 template<class _InputIterator>
627 _M_initialize_dispatch(_InputIterator __first, _InputIterator __last,
629 { _M_initialize_range(__first, __last,
630 std::__iterator_category(__first)); }
632 template<class _InputIterator>
633 vector(_InputIterator __first, _InputIterator __last,
634 const allocator_type& __a = allocator_type())
635 : _Bvector_base<_Alloc>(__a)
637 typedef typename _Is_integer<_InputIterator>::_Integral _Integral;
638 _M_initialize_dispatch(__first, __last, _Integral());
643 vector& operator=(const vector& __x)
647 if (__x.size() > capacity())
649 this->_M_deallocate();
650 _M_initialize(__x.size());
652 std::copy(__x.begin(), __x.end(), begin());
653 this->_M_impl._M_finish = begin() + difference_type(__x.size());
657 // assign(), a generalized assignment member function. Two
658 // versions: one that takes a count, and one that takes a range.
659 // The range version is a member template, so we dispatch on whether
660 // or not the type is an integer.
662 void _M_fill_assign(size_t __n, bool __x)
666 std::fill(this->_M_impl._M_start._M_p,
667 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
668 insert(end(), __n - size(), __x);
672 erase(begin() + __n, end());
673 std::fill(this->_M_impl._M_start._M_p,
674 this->_M_impl._M_end_of_storage, __x ? ~0 : 0);
678 void assign(size_t __n, bool __x)
679 { _M_fill_assign(__n, __x); }
681 template<class _InputIterator>
682 void assign(_InputIterator __first, _InputIterator __last)
684 typedef typename _Is_integer<_InputIterator>::_Integral _Integral;
685 _M_assign_dispatch(__first, __last, _Integral());
688 template<class _Integer>
689 void _M_assign_dispatch(_Integer __n, _Integer __val, __true_type)
690 { _M_fill_assign((size_t) __n, (bool) __val); }
692 template<class _InputIterator>
693 void _M_assign_dispatch(_InputIterator __first, _InputIterator __last,
695 { _M_assign_aux(__first, __last, std::__iterator_category(__first)); }
697 template<class _InputIterator>
698 void _M_assign_aux(_InputIterator __first, _InputIterator __last,
701 iterator __cur = begin();
702 for ( ; __first != __last && __cur != end(); ++__cur, ++__first)
704 if (__first == __last)
707 insert(end(), __first, __last);
710 template<class _ForwardIterator>
711 void _M_assign_aux(_ForwardIterator __first, _ForwardIterator __last,
712 forward_iterator_tag)
714 const size_type __len = std::distance(__first, __last);
716 erase(std::copy(__first, __last, begin()), end());
719 _ForwardIterator __mid = __first;
720 std::advance(__mid, size());
721 std::copy(__first, __mid, begin());
722 insert(end(), __mid, __last);
726 void reserve(size_type __n)
728 if (__n > this->max_size())
729 __throw_length_error(__N("vector::reserve"));
730 if (this->capacity() < __n)
732 _Bit_type* __q = this->_M_allocate(__n);
733 this->_M_impl._M_finish = std::copy(begin(), end(),
735 this->_M_deallocate();
736 this->_M_impl._M_start = iterator(__q, 0);
737 this->_M_impl._M_end_of_storage = __q + (__n + _S_word_bit - 1) / _S_word_bit;
744 const_reference front() const
748 { return *(end() - 1); }
750 const_reference back() const
751 { return *(end() - 1); }
753 void push_back(bool __x)
755 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage)
756 *this->_M_impl._M_finish++ = __x;
758 _M_insert_aux(end(), __x);
761 void swap(vector<bool, _Alloc>& __x)
763 std::swap(this->_M_impl._M_start, __x._M_impl._M_start);
764 std::swap(this->_M_impl._M_finish, __x._M_impl._M_finish);
765 std::swap(this->_M_impl._M_end_of_storage,
766 __x._M_impl._M_end_of_storage);
769 // [23.2.5]/1, third-to-last entry in synopsis listing
770 static void swap(reference __x, reference __y)
777 iterator insert(iterator __position, bool __x = bool())
779 const difference_type __n = __position - begin();
780 if (this->_M_impl._M_finish._M_p != this->_M_impl._M_end_of_storage
781 && __position == end())
782 *this->_M_impl._M_finish++ = __x;
784 _M_insert_aux(__position, __x);
785 return begin() + __n;
788 // Check whether it's an integral type. If so, it's not an iterator.
790 template<class _Integer>
791 void _M_insert_dispatch(iterator __pos, _Integer __n, _Integer __x,
793 { _M_fill_insert(__pos, __n, __x); }
795 template<class _InputIterator>
796 void _M_insert_dispatch(iterator __pos,
797 _InputIterator __first, _InputIterator __last,
799 { _M_insert_range(__pos, __first, __last,
800 std::__iterator_category(__first)); }
802 template<class _InputIterator>
803 void insert(iterator __position,
804 _InputIterator __first, _InputIterator __last)
806 typedef typename _Is_integer<_InputIterator>::_Integral _Integral;
807 _M_insert_dispatch(__position, __first, __last, _Integral());
810 void _M_fill_insert(iterator __position, size_type __n, bool __x)
814 if (capacity() - size() >= __n)
816 std::copy_backward(__position, end(),
817 this->_M_impl._M_finish + difference_type(__n));
818 std::fill(__position, __position + difference_type(__n), __x);
819 this->_M_impl._M_finish += difference_type(__n);
823 const size_type __len = size() + std::max(size(), __n);
824 _Bit_type * __q = this->_M_allocate(__len);
825 iterator __i = std::copy(begin(), __position, iterator(__q, 0));
826 std::fill_n(__i, __n, __x);
827 this->_M_impl._M_finish = std::copy(__position, end(),
828 __i + difference_type(__n));
829 this->_M_deallocate();
830 this->_M_impl._M_end_of_storage = __q + (__len + _S_word_bit - 1)
832 this->_M_impl._M_start = iterator(__q, 0);
836 void insert(iterator __position, size_type __n, bool __x)
837 { _M_fill_insert(__position, __n, __x); }
840 { --this->_M_impl._M_finish; }
842 iterator erase(iterator __position)
844 if (__position + 1 != end())
845 std::copy(__position + 1, end(), __position);
846 --this->_M_impl._M_finish;
850 iterator erase(iterator __first, iterator __last)
852 this->_M_impl._M_finish = std::copy(__last, end(), __first);
856 void resize(size_type __new_size, bool __x = bool())
858 if (__new_size < size())
859 erase(begin() + difference_type(__new_size), end());
861 insert(end(), __new_size - size(), __x);
866 for (_Bit_type * __p = this->_M_impl._M_start._M_p;
867 __p != this->_M_impl._M_end_of_storage; ++__p)
872 { erase(begin(), end()); }