Meets the requirements of a container, a reversible container, and a sequence, including the optional sequence requirements.
In previous HP/SGI versions of deque, there was an extra template parameter so users could control the node size. This extension turned out to violate the C++ standard (it can be detected using template template parameters), and it was removed.
Here's how a deque<Tp> manages memory. Each deque has 4 members:
map_size is at least 8. map is an array of map_size pointers-to-"nodes". (The name map has nothing to do with the std::map class, and "nodes" should not be confused with std::list's usage of "node".)
A "node" has no specific type name as such, but it is referred to as "node" in this file. It is a simple array-of-Tp. If Tp is very large, there will be one Tp element per node (i.e., an "array" of one). For non-huge Tp's, node size is inversely related to Tp size: the larger the Tp, the fewer Tp's will fit in a node. The goal here is to keep the total size of a node relatively small and constant over different Tp's, to improve allocator efficiency.
Not every pointer in the map array will point to a node. If the initial number of elements in the deque is small, the /middle/ map pointers will be valid, and the ones at the edges will be unused. This same situation will arise as the map grows: available map pointers, if any, will be on the ends. As new nodes are created, only a subset of the map's pointers need to be copied "outward".
Class invariants:
Here's the magic: nothing in deque is "aware" of the discontiguous storage!
The memory setup and layout occurs in the parent, _Base, and the iterator class is entirely responsible for "leaping" from one node to the next. All the implementation routines for deque itself work only through the start and finish iterators. This keeps the routines simple and sane, and we can use other standard algorithms as well.
Definition at line 643 of file stl_deque.h.
std::deque< _Tp, _Alloc >::deque | ( | ) | [inline] |
std::deque< _Tp, _Alloc >::deque | ( | const allocator_type & | __a | ) | [inline, explicit] |
Creates a deque with no elements.
a | An allocator object. |
Definition at line 703 of file stl_deque.h.
std::deque< _Tp, _Alloc >::deque | ( | size_type | __n, | |
const value_type & | __value = value_type() , |
|||
const allocator_type & | __a = allocator_type() | |||
) | [inline, explicit] |
Creates a deque with copies of an exemplar element.
n | The number of elements to initially create. | |
value | An element to copy. | |
a | An allocator. |
Definition at line 715 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_fill_initialize().
std::deque< _Tp, _Alloc >::deque | ( | const deque< _Tp, _Alloc > & | __x | ) | [inline] |
Deque copy constructor.
x | A deque of identical element and allocator types. |
Definition at line 727 of file stl_deque.h.
References std::__uninitialized_copy_a(), std::_Deque_base< _Tp, _Alloc >::_M_get_Tp_allocator(), std::_Deque_base< _Tp, _Alloc >::_M_impl, std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::end().
std::deque< _Tp, _Alloc >::deque | ( | _InputIterator | __first, | |
_InputIterator | __last, | |||
const allocator_type & | __a = allocator_type() | |||
) | [inline] |
Builds a deque from a range.
first | An input iterator. | |
last | An input iterator. | |
a | An allocator object. |
If the iterators are forward, bidirectional, or random-access, then this will call the elements' copy constructor N times (where N is distance(first,last)) and do no memory reallocation. But if only input iterators are used, then this will do at most 2N calls to the copy constructor, and logN memory reallocations.
Definition at line 761 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_initialize_dispatch().
std::deque< _Tp, _Alloc >::~deque | ( | ) | [inline] |
The dtor only erases the elements, and note that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 775 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_destroy_data(), std::_Deque_base< _Tp, _Alloc >::_M_get_Tp_allocator(), std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::end().
void deque::_M_fill_initialize | ( | const value_type & | __value | ) | [protected] |
Fills the deque with copies of value.
value | Initial value. |
Definition at line 247 of file deque.tcc.
References std::__uninitialized_fill_a(), std::_Destroy(), std::_Deque_base< _Tp, _Alloc >::_M_get_Tp_allocator(), std::_Deque_base< _Tp, _Alloc >::_M_impl, and std::deque< _Tp, _Alloc >::_S_buffer_size().
Referenced by std::deque< _Tp, _Alloc >::_M_initialize_dispatch(), and std::deque< _Tp, _Alloc >::deque().
void std::_Deque_base< _Tp, _Alloc >::_M_initialize_map | ( | size_t | __num_elements | ) | [protected, inherited] |
Layout storage.
num_elements | The count of T's for which to allocate space at first. |
Definition at line 497 of file stl_deque.h.
References std::__deque_buf_size(), std::_Deque_base< _Tp, _Alloc >::_M_allocate_map(), std::_Deque_base< _Tp, _Alloc >::_M_create_nodes(), std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_cur, std::_Deque_base< _Tp, _Alloc >::_M_deallocate_map(), std::_Deque_base< _Tp, _Alloc >::_Deque_impl::_M_finish, std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_first, std::_Deque_base< _Tp, _Alloc >::_M_impl, std::_Deque_base< _Tp, _Alloc >::_Deque_impl::_M_map, std::_Deque_base< _Tp, _Alloc >::_Deque_impl::_M_map_size, std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_set_node(), std::_Deque_base< _Tp, _Alloc >::_Deque_impl::_M_start, and std::max().
Referenced by std::deque< _Tp, _Alloc >::_M_initialize_dispatch(), and std::deque< _Tp, _Alloc >::_M_range_initialize().
void deque::_M_push_back_aux | ( | const value_type & | ) | [protected] |
Helper functions for push_* and pop_*.
Definition at line 335 of file deque.tcc.
Referenced by std::deque< _Tp, _Alloc >::push_back().
void std::deque< _Tp, _Alloc >::_M_range_check | ( | size_type | __n | ) | const [inline, protected] |
Safety check used only from at().
Definition at line 1027 of file stl_deque.h.
References __N.
Referenced by std::deque< _Tp, _Alloc >::at().
void deque::_M_range_initialize | ( | _InputIterator | __first, | |
_InputIterator | __last, | |||
std::input_iterator_tag | ||||
) | [protected] |
Fills the deque with whatever is in [first,last).
first | An input iterator. | |
last | An input iterator. |
Definition at line 273 of file deque.tcc.
References std::_Deque_base< _Tp, _Alloc >::_M_initialize_map(), std::deque< _Tp, _Alloc >::clear(), and std::deque< _Tp, _Alloc >::push_back().
Referenced by std::deque< _Tp, _Alloc >::_M_initialize_dispatch().
iterator std::deque< _Tp, _Alloc >::_M_reserve_elements_at_front | ( | size_type | __n | ) | [inline, protected] |
Memory-handling helpers for the previous internal insert functions.
Definition at line 1630 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl, and std::deque< _Tp, _Alloc >::_M_new_elements_at_front().
Referenced by std::deque< _Tp, _Alloc >::_M_fill_insert(), std::deque< _Tp, _Alloc >::_M_insert_aux(), and std::deque< _Tp, _Alloc >::_M_range_insert_aux().
void std::deque< _Tp, _Alloc >::_M_reserve_map_at_back | ( | size_type | __nodes_to_add = 1 |
) | [inline, protected] |
Memory-handling helpers for the major map.
Makes sure the _M_map has space for new nodes. Does not actually add the nodes. Can invalidate _M_map pointers. (And consequently, deque iterators.)
Definition at line 1666 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_reallocate_map().
Referenced by std::deque< _Tp, _Alloc >::_M_new_elements_at_back().
void std::deque< _Tp, _Alloc >::assign | ( | _InputIterator | __first, | |
_InputIterator | __last | |||
) | [inline] |
Assigns a range to a deque.
first | An input iterator. | |
last | An input iterator. |
Note that the assignment completely changes the deque and that the resulting deque's size is the same as the number of elements assigned. Old data may be lost.
Definition at line 834 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_assign_dispatch().
void std::deque< _Tp, _Alloc >::assign | ( | size_type | __n, | |
const value_type & | __val | |||
) | [inline] |
Assigns a given value to a deque.
n | Number of elements to be assigned. | |
val | Value to be assigned. |
Definition at line 817 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_fill_assign().
const_reference std::deque< _Tp, _Alloc >::at | ( | size_type | __n | ) | const [inline] |
Provides access to the data contained in the deque.
n | The index of the element for which data should be accessed. |
std::out_of_range | If n is an invalid index. |
Definition at line 1064 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_range_check().
reference std::deque< _Tp, _Alloc >::at | ( | size_type | __n | ) | [inline] |
Provides access to the data contained in the deque.
n | The index of the element for which data should be accessed. |
std::out_of_range | If n is an invalid index. |
Definition at line 1046 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_range_check().
const_reference std::deque< _Tp, _Alloc >::back | ( | ) | const [inline] |
Returns a read-only (constant) reference to the data at the last element of the deque.
Definition at line 1103 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::end().
reference std::deque< _Tp, _Alloc >::back | ( | ) | [inline] |
Returns a read/write reference to the data at the last element of the deque.
Definition at line 1091 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::end().
Referenced by std::deque< _Tp, _Alloc >::_M_insert_aux().
const_iterator std::deque< _Tp, _Alloc >::begin | ( | ) | const [inline] |
Returns a read-only (constant) iterator that points to the first element in the deque. Iteration is done in ordinary element order.
Definition at line 859 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
iterator std::deque< _Tp, _Alloc >::begin | ( | ) | [inline] |
Returns a read/write iterator that points to the first element in the deque. Iteration is done in ordinary element order.
Definition at line 851 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
Referenced by std::deque< _Tp, _Alloc >::_M_assign_aux(), std::deque< _Tp, _Alloc >::_M_erase_at_begin(), std::deque< _Tp, _Alloc >::_M_fill_assign(), std::deque< _Tp, _Alloc >::clear(), std::deque< _Tp, _Alloc >::deque(), std::deque< _Tp, _Alloc >::erase(), std::deque< _Tp, _Alloc >::front(), std::operator==(), and std::deque< _Tp, _Alloc >::~deque().
void std::deque< _Tp, _Alloc >::clear | ( | ) | [inline] |
Erases all the elements. Note that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 1373 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_erase_at_end(), and std::deque< _Tp, _Alloc >::begin().
Referenced by std::deque< _Tp, _Alloc >::_M_range_initialize(), and std::deque< _Tp, _Alloc >::erase().
bool std::deque< _Tp, _Alloc >::empty | ( | ) | const [inline] |
Returns true if the deque is empty. (Thus begin() would equal end().)
Definition at line 990 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
const_iterator std::deque< _Tp, _Alloc >::end | ( | ) | const [inline] |
Returns a read-only (constant) iterator that points one past the last element in the deque. Iteration is done in ordinary element order.
Definition at line 877 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
iterator std::deque< _Tp, _Alloc >::end | ( | ) | [inline] |
Returns a read/write iterator that points one past the last element in the deque. Iteration is done in ordinary element order.
Definition at line 868 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
Referenced by std::deque< _Tp, _Alloc >::_M_assign_aux(), std::deque< _Tp, _Alloc >::_M_erase_at_end(), std::deque< _Tp, _Alloc >::_M_fill_assign(), std::deque< _Tp, _Alloc >::back(), std::deque< _Tp, _Alloc >::deque(), std::deque< _Tp, _Alloc >::erase(), std::operator==(), and std::deque< _Tp, _Alloc >::~deque().
deque< _Tp, _Alloc >::iterator deque::erase | ( | iterator | __first, | |
iterator | __last | |||
) |
Remove a range of elements.
first | Iterator pointing to the first element to be erased. | |
last | Iterator pointing to one past the last element to be erased. |
The user is cautioned that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 159 of file deque.tcc.
References _GLIBCXX_MOVE3, _GLIBCXX_MOVE_BACKWARD3, std::deque< _Tp, _Alloc >::_M_erase_at_begin(), std::deque< _Tp, _Alloc >::_M_erase_at_end(), std::deque< _Tp, _Alloc >::begin(), std::deque< _Tp, _Alloc >::clear(), std::deque< _Tp, _Alloc >::end(), and std::deque< _Tp, _Alloc >::size().
deque< _Tp, _Alloc >::iterator deque::erase | ( | iterator | __position | ) |
Remove element at given position.
position | Iterator pointing to element to be erased. |
The user is cautioned that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 136 of file deque.tcc.
References _GLIBCXX_MOVE3, _GLIBCXX_MOVE_BACKWARD3, std::deque< _Tp, _Alloc >::begin(), std::deque< _Tp, _Alloc >::end(), std::deque< _Tp, _Alloc >::pop_back(), std::deque< _Tp, _Alloc >::pop_front(), and std::deque< _Tp, _Alloc >::size().
const_reference std::deque< _Tp, _Alloc >::front | ( | ) | const [inline] |
Returns a read-only (constant) reference to the data at the first element of the deque.
Definition at line 1083 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::begin().
reference std::deque< _Tp, _Alloc >::front | ( | ) | [inline] |
Returns a read/write reference to the data at the first element of the deque.
Definition at line 1075 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::begin().
Referenced by std::deque< _Tp, _Alloc >::_M_insert_aux().
allocator_type std::deque< _Tp, _Alloc >::get_allocator | ( | ) | const [inline] |
Get a copy of the memory allocation object.
Reimplemented from std::_Deque_base< _Tp, _Alloc >.
Definition at line 842 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::get_allocator().
void std::deque< _Tp, _Alloc >::insert | ( | iterator | __position, | |
_InputIterator | __first, | |||
_InputIterator | __last | |||
) | [inline] |
Inserts a range into the deque.
position | An iterator into the deque. | |
first | An input iterator. | |
last | An input iterator. |
Definition at line 1296 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_insert_dispatch().
void std::deque< _Tp, _Alloc >::insert | ( | iterator | __position, | |
size_type | __n, | |||
const value_type & | __x | |||
) | [inline] |
Inserts a number of copies of given data into the deque.
position | An iterator into the deque. | |
n | Number of elements to be inserted. | |
x | Data to be inserted. |
Definition at line 1281 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_fill_insert().
deque< _Tp, _Alloc >::iterator deque::insert | ( | iterator | __position, | |
const value_type & | __x | |||
) |
Inserts given value into deque before specified iterator.
position | An iterator into the deque. | |
x | Data to be inserted. |
Definition at line 91 of file deque.tcc.
References std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_cur, std::_Deque_base< _Tp, _Alloc >::_M_impl, std::deque< _Tp, _Alloc >::_M_insert_aux(), std::deque< _Tp, _Alloc >::push_back(), and std::deque< _Tp, _Alloc >::push_front().
Referenced by std::deque< _Tp, _Alloc >::_M_assign_aux(), std::deque< _Tp, _Alloc >::_M_fill_assign(), and std::deque< _Tp, _Alloc >::resize().
size_type std::deque< _Tp, _Alloc >::max_size | ( | ) | const [inline] |
Returns the size() of the largest possible deque.
Definition at line 961 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_get_Tp_allocator().
const_reference std::deque< _Tp, _Alloc >::operator[] | ( | size_type | __n | ) | const [inline] |
Subscript access to the data contained in the deque.
n | The index of the element for which data should be accessed. |
Definition at line 1021 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
reference std::deque< _Tp, _Alloc >::operator[] | ( | size_type | __n | ) | [inline] |
Subscript access to the data contained in the deque.
n | The index of the element for which data should be accessed. |
Definition at line 1006 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
void std::deque< _Tp, _Alloc >::pop_back | ( | ) | [inline] |
Removes last element.
This is a typical stack operation. It shrinks the deque by one.
Note that no data is returned, and if the last element's data is needed, it should be retrieved before pop_back() is called.
Definition at line 1217 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl, and std::deque< _Tp, _Alloc >::_M_pop_back_aux().
Referenced by std::deque< _Tp, _Alloc >::erase().
void std::deque< _Tp, _Alloc >::pop_front | ( | ) | [inline] |
Removes first element.
This is a typical stack operation. It shrinks the deque by one.
Note that no data is returned, and if the first element's data is needed, it should be retrieved before pop_front() is called.
Definition at line 1196 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl, and std::deque< _Tp, _Alloc >::_M_pop_front_aux().
Referenced by std::deque< _Tp, _Alloc >::erase().
void std::deque< _Tp, _Alloc >::push_back | ( | const value_type & | __x | ) | [inline] |
Add data to the end of the deque.
x | Data to be added. |
Definition at line 1159 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl, and std::deque< _Tp, _Alloc >::_M_push_back_aux().
Referenced by std::deque< _Tp, _Alloc >::_M_insert_aux(), std::deque< _Tp, _Alloc >::_M_range_initialize(), and std::deque< _Tp, _Alloc >::insert().
void std::deque< _Tp, _Alloc >::push_front | ( | const value_type & | __x | ) | [inline] |
Add data to the front of the deque.
x | Data to be added. |
Definition at line 1122 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl, and std::deque< _Tp, _Alloc >::_M_push_front_aux().
Referenced by std::deque< _Tp, _Alloc >::_M_insert_aux(), and std::deque< _Tp, _Alloc >::insert().
const_reverse_iterator std::deque< _Tp, _Alloc >::rbegin | ( | ) | const [inline] |
Returns a read-only (constant) reverse iterator that points to the last element in the deque. Iteration is done in reverse element order.
Definition at line 895 of file stl_deque.h.
reverse_iterator std::deque< _Tp, _Alloc >::rbegin | ( | ) | [inline] |
Returns a read/write reverse iterator that points to the last element in the deque. Iteration is done in reverse element order.
Definition at line 886 of file stl_deque.h.
const_reverse_iterator std::deque< _Tp, _Alloc >::rend | ( | ) | const [inline] |
Returns a read-only (constant) reverse iterator that points to one before the first element in the deque. Iteration is done in reverse element order.
Definition at line 913 of file stl_deque.h.
reverse_iterator std::deque< _Tp, _Alloc >::rend | ( | ) | [inline] |
Returns a read/write reverse iterator that points to one before the first element in the deque. Iteration is done in reverse element order.
Definition at line 904 of file stl_deque.h.
void std::deque< _Tp, _Alloc >::resize | ( | size_type | __new_size, | |
value_type | __x = value_type() | |||
) | [inline] |
Resizes the deque to the specified number of elements.
new_size | Number of elements the deque should contain. | |
x | Data with which new elements should be populated. |
Definition at line 976 of file stl_deque.h.
References std::deque< _Tp, _Alloc >::_M_erase_at_end(), std::deque< _Tp, _Alloc >::insert(), and std::deque< _Tp, _Alloc >::size().
size_type std::deque< _Tp, _Alloc >::size | ( | ) | const [inline] |
Returns the number of elements in the deque.
Definition at line 956 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_impl.
Referenced by std::deque< _Tp, _Alloc >::_M_assign_aux(), std::deque< _Tp, _Alloc >::_M_fill_assign(), std::deque< _Tp, _Alloc >::_M_insert_aux(), std::deque< _Tp, _Alloc >::_M_new_elements_at_back(), std::deque< _Tp, _Alloc >::_M_new_elements_at_front(), std::deque< _Tp, _Alloc >::erase(), std::operator==(), and std::deque< _Tp, _Alloc >::resize().
void std::deque< _Tp, _Alloc >::swap | ( | deque< _Tp, _Alloc > & | __x | ) | [inline] |
Swaps data with another deque.
x | A deque of the same element and allocator types. |
Definition at line 1352 of file stl_deque.h.
References std::_Deque_base< _Tp, _Alloc >::_M_get_Tp_allocator(), std::_Deque_base< _Tp, _Alloc >::_M_impl, std::__alloc_swap< _Alloc, >::_S_do_it(), and std::swap().
Referenced by std::swap().