Namespaces
Variants
Views
Actions

std::vector<bool>

From cppreference.com
< cpp‎ | container
Revision as of 17:20, 17 August 2013 by Cubbi (Talk | contribs)

Defined in header <vector>
template<class Allocator = std::allocator<bool>>
class vector<bool, Allocator>;

std::vector<bool> is a space-efficient specialization of std::vector for the type bool.

The manner in which std::vector<bool> is made space efficient (as well as whether it is optimized at all) is implementation defined. One potential optimization involves coalescing vector elements such that each element occupies a single bit instead of sizeof(bool) bytes.

std::vector<bool> behaves similarly to std::vector, but in order to be space efficient, it:

  • Does not necessarily store its data in a single contiguous chunk of memory.
  • Exposes std::vector<bool>::reference as a method of accessing individual bits.
  • Does not use std::allocator_traits::construct to construct bit values.

Contents

Member types

Member type Definition
value_type bool [edit]
allocator_type Allocator [edit]
size_type implementation-defined [edit]
difference_type implementation-defined[edit]
proxy class representing a reference to a single bool
(class)
const_reference bool [edit]
pointer implementation-defined[edit]
const_pointer implementation-defined[edit]
iterator implementation-defined [edit]
const_iterator implementation-defined [edit]
reverse_iterator std::reverse_iterator<iterator> [edit]
const_reverse_iterator std::reverse_iterator<const_iterator> [edit]

Member functions

constructs the vector
(public member function of std::vector) [edit]
destructs the vector
(public member function of std::vector) [edit]
assigns values to the container
(public member function of std::vector) [edit]
assigns values to the container
(public member function of std::vector) [edit]
returns the associated allocator
(public member function of std::vector) [edit]
Element access
access specified element with bounds checking
(public member function of std::vector) [edit]
access specified element
(public member function of std::vector) [edit]
access the first element
(public member function of std::vector) [edit]
access the last element
(public member function of std::vector) [edit]
Iterators
returns an iterator to the beginning
(public member function of std::vector) [edit]
returns an iterator to the end
(public member function of std::vector) [edit]
returns a reverse iterator to the beginning
(public member function of std::vector) [edit]
returns a reverse iterator to the end
(public member function of std::vector) [edit]
Capacity
checks whether the container is empty
(public member function of std::vector) [edit]
returns the number of elements
(public member function of std::vector) [edit]
returns the maximum possible number of elements
(public member function of std::vector) [edit]
reserves storage
(public member function of std::vector) [edit]
returns the number of elements that can be held in currently allocated storage
(public member function of std::vector) [edit]
Modifiers
clears the contents
(public member function of std::vector) [edit]
inserts elements
(public member function of std::vector) [edit]
(C++11)
constructs element in-place
(public member function of std::vector) [edit]
erases elements
(public member function of std::vector) [edit]
adds elements to the end
(public member function of std::vector) [edit]
removes the last element
(public member function of std::vector) [edit]
constructs elements in-place at the end
(public member function of std::vector) [edit]
changes the number of elements stored
(public member function of std::vector) [edit]
swaps the contents
(public member function of std::vector) [edit]
vector<bool> specific modifiers
flips all the bits
(public member function) [edit]
[static]
swaps two std::vector<bool>::references
(public static member function) [edit]

Non-member functions

lexicographically compares the values in the vector
(function template) [edit]
specializes the std::swap algorithm
(function template) [edit]

Helper classes

hash support for std::vector<bool>
(class template specialization) [edit]

Notes

If the size of the bitset is known at compile time, std::bitset may be used, which offers a richer set of member functions. In addition, boost::dynamic_bitset exists as an alternative to std::vector<bool>.

Since its representation may by optimized, std::vector<bool> does not necessarily meet all Container or SequenceContainer requirements. For example, because std::vector<bool>::iterator is implementation-defined, it may not satisfy the ForwardIterator requirement. Use of algorithms such as std::search that require ForwardIterators may result in either compile-time or run-time errors.