std::deque< _Tp, _Alloc > Class Template Reference

Inheritance diagram for std::deque< _Tp, _Alloc >:

Public Types
typedef _Alloc	allocator_type
typedef _Base::const_iterator	const_iterator
typedef _Alloc_traits::const_pointer	const_pointer
typedef _Alloc_traits::const_reference	const_reference
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
typedef ptrdiff_t	difference_type
typedef _Base::iterator	iterator
typedef _Alloc_traits::pointer	pointer
typedef _Alloc_traits::reference	reference
typedef std::reverse_iterator< iterator >	reverse_iterator
typedef size_t	size_type
typedef _Tp	value_type

Public Member Functions
	deque ()=default
template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>>
	deque (_InputIterator __first, _InputIterator __last, const allocator_type &__a=allocator_type())
	deque (const allocator_type &__a)
	deque (const deque &__x)
	deque (const deque &__x, const allocator_type &__a)
	deque (deque &&)=default
	deque (deque &&__x, const allocator_type &__a)
	deque (initializer_list< value_type > __l, const allocator_type &__a=allocator_type())
	deque (size_type __n, const allocator_type &__a=allocator_type())
	deque (size_type __n, const value_type &__value, const allocator_type &__a=allocator_type())
	~deque ()
template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>>
void	assign (_InputIterator __first, _InputIterator __last)
void	assign (initializer_list< value_type > __l)
void	assign (size_type __n, const value_type &__val)
reference	at (size_type __n)
const_reference	at (size_type __n) const
const_reference	back () const noexcept
reference	back () noexcept
const_iterator	begin () const noexcept
iterator	begin () noexcept
const_iterator	cbegin () const noexcept
const_iterator	cend () const noexcept
void	clear () noexcept
const_reverse_iterator	crbegin () const noexcept
const_reverse_iterator	crend () const noexcept
template<typename... _Args>
iterator	emplace (const_iterator __position, _Args &&... __args)
template<typename... _Args>
void	emplace_back (_Args &&... __args)
template<typename... _Args>
void	emplace_front (_Args &&... __args)
bool	empty () const noexcept
const_iterator	end () const noexcept
iterator	end () noexcept
iterator	erase (const_iterator __first, const_iterator __last)
iterator	erase (const_iterator __position)
const_reference	front () const noexcept
reference	front () noexcept
allocator_type	get_allocator () const noexcept
iterator	insert (const_iterator __p, initializer_list< value_type > __l)
template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>>
iterator	insert (const_iterator __position, _InputIterator __first, _InputIterator __last)
iterator	insert (const_iterator __position, const value_type &__x)
iterator	insert (const_iterator __position, size_type __n, const value_type &__x)
iterator	insert (const_iterator __position, value_type &&__x)
size_type	max_size () const noexcept
deque &	operator= (const deque &__x)
deque &	operator= (deque &&__x) noexcept(_Alloc_traits::_S_always_equal())
deque &	operator= (initializer_list< value_type > __l)
const_reference	operator[] (size_type __n) const noexcept
reference	operator[] (size_type __n) noexcept
void	pop_back () noexcept
void	pop_front () noexcept
void	push_back (const value_type &__x)
void	push_back (value_type &&__x)
void	push_front (const value_type &__x)
void	push_front (value_type &&__x)
const_reverse_iterator	rbegin () const noexcept
reverse_iterator	rbegin () noexcept
const_reverse_iterator	rend () const noexcept
reverse_iterator	rend () noexcept
void	resize (size_type __new_size)
void	resize (size_type __new_size, const value_type &__x)
void	shrink_to_fit () noexcept
size_type	size () const noexcept
void	swap (deque &__x) noexcept

Protected Types
enum
typedef __gnu_cxx::__alloc_traits< _Map_alloc_type >	_Map_alloc_traits
typedef _Alloc_traits::template rebind< _Ptr >::other	_Map_alloc_type
typedef _Alloc_traits::pointer	_Ptr
typedef _Alloc_traits::const_pointer	_Ptr_const

Protected Member Functions
_Map_pointer	_M_allocate_map (size_t __n)
template<typename _ForwardIterator >
void	_M_assign_aux (_ForwardIterator __first, _ForwardIterator __last, std::forward_iterator_tag)
template<typename _InputIterator >
void	_M_assign_aux (_InputIterator __first, _InputIterator __last, std::input_iterator_tag)
void	_M_create_nodes (_Map_pointer __nstart, _Map_pointer __nfinish)
void	_M_deallocate_map (_Map_pointer __p, size_t __n) noexcept
void	_M_deallocate_node (_Ptr __p) noexcept
void	_M_default_append (size_type __n)
void	_M_default_initialize ()
template<typename _Alloc1 >
void	_M_destroy_data (iterator __first, iterator __last, const _Alloc1 &)
void	_M_destroy_data (iterator __first, iterator __last, const std::allocator< _Tp > &)
void	_M_destroy_data_aux (iterator __first, iterator __last)
void	_M_destroy_nodes (_Map_pointer __nstart, _Map_pointer __nfinish) noexcept
iterator	_M_erase (iterator __first, iterator __last)
iterator	_M_erase (iterator __pos)
void	_M_erase_at_begin (iterator __pos)
void	_M_erase_at_end (iterator __pos)
void	_M_fill_assign (size_type __n, const value_type &__val)
void	_M_fill_initialize (const value_type &__value)
void	_M_fill_insert (iterator __pos, size_type __n, const value_type &__x)
_Map_alloc_type	_M_get_map_allocator () const noexcept
const _Tp_alloc_type &	_M_get_Tp_allocator () const noexcept
void	_M_initialize_map (size_t)
template<typename... _Args>
iterator	_M_insert_aux (iterator __pos, _Args &&... __args)
template<typename _ForwardIterator >
void	_M_insert_aux (iterator __pos, _ForwardIterator __first, _ForwardIterator __last, size_type __n)
void	_M_insert_aux (iterator __pos, size_type __n, const value_type &__x)
void	_M_move_assign1 (deque &&__x, false_type)
void	_M_move_assign1 (deque &&__x, true_type) noexcept
void	_M_move_assign2 (deque &&__x, false_type)
void	_M_move_assign2 (deque &&__x, true_type)
void	_M_range_check (size_type __n) const
template<typename _ForwardIterator >
void	_M_range_insert_aux (iterator __pos, _ForwardIterator __first, _ForwardIterator __last, std::forward_iterator_tag)
template<typename _InputIterator >
void	_M_range_insert_aux (iterator __pos, _InputIterator __first, _InputIterator __last, std::input_iterator_tag)
template<typename... _Args>
void	_M_replace_map (_Args &&... __args)
bool	_M_shrink_to_fit ()
template<typename _InputIterator >
void	_M_range_initialize (_InputIterator __first, _InputIterator __last, std::input_iterator_tag)
template<typename _ForwardIterator >
void	_M_range_initialize (_ForwardIterator __first, _ForwardIterator __last, std::forward_iterator_tag)
template<typename... _Args>
void	_M_push_back_aux (_Args &&... __args)
template<typename... _Args>
void	_M_push_front_aux (_Args &&... __args)
void	_M_pop_back_aux ()
void	_M_pop_front_aux ()
iterator	_M_reserve_elements_at_front (size_type __n)
iterator	_M_reserve_elements_at_back (size_type __n)
void	_M_new_elements_at_front (size_type __new_elements)
void	_M_new_elements_at_back (size_type __new_elements)
void	_M_reserve_map_at_back (size_type __nodes_to_add=1)
void	_M_reserve_map_at_front (size_type __nodes_to_add=1)
void	_M_reallocate_map (size_type __nodes_to_add, bool __add_at_front)

Static Protected Member Functions
static size_t	_S_check_init_len (size_t __n, const allocator_type &__a)
static size_type	_S_max_size (const _Tp_alloc_type &__a) noexcept

Detailed Description

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
class std::deque< _Tp, _Alloc >

A standard container using fixed-size memory allocation and constant-time manipulation of elements at either end.

Template Parameters

_Tp	Type of element.
_Alloc	Allocator type, defaults to allocator<_Tp>.

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:

• Tp** _M_map
• size_t _M_map_size
• iterator _M_start, _M_finish

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:

• For any nonsingular iterator i:
  • i.node points to a member of the map array. (Yes, you read that correctly: i.node does not actually point to a node.) The member of the map array is what actually points to the node.
  • i.first == *(i.node) (This points to the node (first Tp element).)
  • i.last == i.first + node_size
  • i.cur is a pointer in the range [i.first, i.last). NOTE: the implication of this is that i.cur is always a dereferenceable pointer, even if i is a past-the-end iterator.
• Start and Finish are always nonsingular iterators. NOTE: this means that an empty deque must have one node, a deque with <N elements (where N is the node buffer size) must have one node, a deque with N through (2N-1) elements must have two nodes, etc.
• For every node other than start.node and finish.node, every element in the node is an initialized object. If start.node == finish.node, then [start.cur, finish.cur) are initialized objects, and the elements outside that range are uninitialized storage. Otherwise, [start.cur, start.last) and [finish.first, finish.cur) are initialized objects, and [start.first, start.cur) and [finish.cur, finish.last) are uninitialized storage.
• [map, map + map_size) is a valid, non-empty range.
• [start.node, finish.node] is a valid range contained within [map, map + map_size).

• A pointer in the range [map, map + map_size) points to an allocated node if and only if the pointer is in the range [start.node, finish.node].

  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 764 of file stl_deque.h.

Constructor & Destructor Documentation

deque() [1/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( )

default

Creates a deque with no elements.

deque() [2/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( const allocator_type &  __a )

inlineexplicit

Creates a deque with no elements.

Parameters

__a	An allocator object.

Definition at line 841 of file stl_deque.h.

deque() [3/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( size_type  __n, const allocator_type &  __a = allocator_type()  )

inlineexplicit

Creates a deque with default constructed elements.

Parameters

__n	The number of elements to initially create.
__a	An allocator.

This constructor fills the deque with n default constructed elements.

Definition at line 854 of file stl_deque.h.

deque() [4/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( size_type  __n, const value_type &  __value, const allocator_type &  __a = allocator_type()  )

inline

Creates a deque with copies of an exemplar element.

Parameters

__n	The number of elements to initially create.
__value	An element to copy.
__a	An allocator.

This constructor fills the deque with __n copies of __value.

Definition at line 866 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_fill_initialize().

deque() [5/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( const deque< _Tp, _Alloc > &  __x )

inline

Deque copy constructor.

Parameters

__x	A deque of identical element and allocator types.

The newly-created deque uses a copy of the allocator object used by __x (unless the allocator traits dictate a different object).

Definition at line 893 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::end().

deque() [6/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( deque< _Tp, _Alloc > &&  )

default

Deque move constructor.

The newly-created deque contains the exact contents of the moved instance. The contents of the moved instance are a valid, but unspecified deque.

deque() [7/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( const deque< _Tp, _Alloc > &  __x, const allocator_type &  __a  )

inline

Copy constructor with alternative allocator.

Definition at line 912 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::end().

deque() [8/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( deque< _Tp, _Alloc > &&  __x, const allocator_type &  __a  )

inline

Move constructor with alternative allocator.

Definition at line 919 of file stl_deque.h.

deque() [9/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

std::deque< _Tp, _Alloc >::deque ( initializer_list< value_type >  __l, const allocator_type &  __a = allocator_type()  )

inline

Builds a deque from an initializer list.

Parameters

__l	An initializer_list.
__a	An allocator object.

Create a deque consisting of copies of the elements in the initializer_list __l.

This will call the element type's copy constructor N times (where N is __l.size()) and do no memory reallocation.

Definition at line 952 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_range_initialize().

deque() [10/10]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>>

std::deque< _Tp, _Alloc >::deque ( _InputIterator  __first, _InputIterator  __last, const allocator_type &  __a = allocator_type()  )

inline

Builds a deque from a range.

Parameters

__first	An input iterator.
__last	An input iterator.
__a	An allocator object.

Create a deque consisting of copies of the elements from [__first, __last).

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 979 of file stl_deque.h.

References std::__iterator_category(), and std::deque< _Tp, _Alloc >::_M_range_initialize().

~deque()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

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 1003 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::end().

Member Function Documentation

_M_fill_initialize()

template<typename _Tp , typename _Alloc >

void deque::_M_fill_initialize ( const value_type &  __value )

protected

Fills the deque with copies of value.

Parameters

__value

Initial value.

Returns

Nothing.

Precondition

_M_start and _M_finish have already been initialized, but none of the deque's elements have yet been constructed.

This function is called only when the user provides an explicit size (with or without an explicit exemplar value).

Definition at line 393 of file deque.tcc.

Referenced by std::deque< _Tp, _Alloc >::deque().

_M_initialize_map()

void std::_Deque_base< _Tp, std::allocator< _Tp > >::_M_initialize_map ( size_t  __num_elements )

protectedinherited

Layout storage.

Parameters

__num_elements

The count of T's for which to allocate space at first.

Returns

Nothing.

The initial underlying memory layout is a bit complicated...

Definition at line 583 of file stl_deque.h.

_M_new_elements_at_back()

template<typename _Tp , typename _Alloc >

void deque::_M_new_elements_at_back ( size_type  __new_elements )

protected

Memory-handling helpers for the previous internal insert functions.

Definition at line 903 of file deque.tcc.

Referenced by std::deque< _Tp, _Alloc >::_M_reserve_elements_at_back().

_M_new_elements_at_front()

template<typename _Tp , typename _Alloc >

void deque::_M_new_elements_at_front ( size_type  __new_elements )

protected

Memory-handling helpers for the previous internal insert functions.

Definition at line 878 of file deque.tcc.

Referenced by std::deque< _Tp, _Alloc >::_M_reserve_elements_at_front().

_M_pop_back_aux()

template<typename _Tp , typename _Alloc >

void deque::_M_pop_back_aux

protected

Helper functions for push_* and pop_*.

Definition at line 557 of file deque.tcc.

_M_pop_front_aux()

template<typename _Tp , typename _Alloc >

void deque::_M_pop_front_aux

protected

Helper functions for push_* and pop_*.

Definition at line 573 of file deque.tcc.

_M_push_back_aux()

template<typename _Tp , typename _Alloc >

template<typename... _Args>

void deque::_M_push_back_aux ( _Args &&...  __args )

protected

Helper functions for push_* and pop_*.

Definition at line 481 of file deque.tcc.

Referenced by std::deque< _Tp, _Alloc >::push_back().

_M_push_front_aux()

template<typename _Tp , typename _Alloc >

template<typename... _Args>

void deque::_M_push_front_aux ( _Args &&...  __args )

protected

Helper functions for push_* and pop_*.

Definition at line 520 of file deque.tcc.

Referenced by std::deque< _Tp, _Alloc >::push_front().

_M_range_check()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::_M_range_check ( size_type  __n ) const

inlineprotected

Safety check used only from at().

Definition at line 1351 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::size().

Referenced by std::deque< _Tp, _Alloc >::at().

_M_range_initialize() [1/2]

template<typename _Tp , typename _Alloc >

template<typename _ForwardIterator >

void deque::_M_range_initialize ( _ForwardIterator  __first, _ForwardIterator  __last, std::forward_iterator_tag    )

protected

Fills the deque with whatever is in [first,last).

Parameters

__first	An input iterator.
__last	An input iterator.

Returns

Nothing.

If the iterators are actually forward iterators (or better), then the memory layout can be done all at once. Else we move forward using push_back on each value from the iterator.

Definition at line 443 of file deque.tcc.

References std::distance().

_M_range_initialize() [2/2]

template<typename _Tp , typename _Alloc >

template<typename _InputIterator >

void deque::_M_range_initialize ( _InputIterator  __first, _InputIterator  __last, std::input_iterator_tag    )

protected

Fills the deque with whatever is in [first,last).

Parameters

__first	An input iterator.
__last	An input iterator.

Returns

Nothing.

If the iterators are actually forward iterators (or better), then the memory layout can be done all at once. Else we move forward using push_back on each value from the iterator.

Definition at line 419 of file deque.tcc.

Referenced by std::deque< _Tp, _Alloc >::deque().

_M_reallocate_map()

template<typename _Tp , typename _Alloc >

void deque::_M_reallocate_map ( size_type  __nodes_to_add, bool  __add_at_front  )

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 928 of file deque.tcc.

References std::max().

Referenced by std::deque< _Tp, _Alloc >::_M_reserve_map_at_back(), and std::deque< _Tp, _Alloc >::_M_reserve_map_at_front().

_M_reserve_elements_at_back()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::_M_reserve_elements_at_back ( size_type  __n )

inlineprotected

Memory-handling helpers for the previous internal insert functions.

Definition at line 2097 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_new_elements_at_back().

_M_reserve_elements_at_front()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::_M_reserve_elements_at_front ( size_type  __n )

inlineprotected

Memory-handling helpers for the previous internal insert functions.

Definition at line 2087 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_new_elements_at_front().

_M_reserve_map_at_back()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::_M_reserve_map_at_back ( size_type  __nodes_to_add = 1 )

inlineprotected

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 2123 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_reallocate_map().

_M_reserve_map_at_front()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::_M_reserve_map_at_front ( size_type  __nodes_to_add = 1 )

inlineprotected

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 2131 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_reallocate_map().

assign() [1/3]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>>

void std::deque< _Tp, _Alloc >::assign ( _InputIterator  __first, _InputIterator  __last  )

inline

Assigns a range to a deque.

Parameters

__first	An input iterator.
__last	An input iterator.

This function fills a deque with copies of the elements in the range [__first,__last).

Note that the assignment completely changes the deque and that the resulting deque's size is the same as the number of elements assigned.

Definition at line 1085 of file stl_deque.h.

References std::__iterator_category().

assign() [2/3]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::assign ( initializer_list< value_type >  __l )

inline

Assigns an initializer list to a deque.

Parameters

__l	An initializer_list.

This function fills a deque with copies of the elements in the initializer_list __l.

Note that the assignment completely changes the deque and that the resulting deque's size is the same as the number of elements assigned.

Definition at line 1110 of file stl_deque.h.

assign() [3/3]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::assign ( size_type  __n, const value_type &  __val  )

inline

Assigns a given value to a deque.

Parameters

__n	Number of elements to be assigned.
__val	Value to be assigned.

This function fills a deque with n copies of the given value. Note that the assignment completely changes the deque and that the resulting deque's size is the same as the number of elements assigned.

Definition at line 1066 of file stl_deque.h.

at() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

reference std::deque< _Tp, _Alloc >::at ( size_type  __n )

inline

Provides access to the data contained in the deque.

Parameters

__n	The index of the element for which data should be accessed.

Returns

Read/write reference to data.

Exceptions

std::out_of_range

If __n is an invalid index.

This function provides for safer data access. The parameter is first checked that it is in the range of the deque. The function throws out_of_range if the check fails.

Definition at line 1373 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_range_check().

at() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reference std::deque< _Tp, _Alloc >::at ( size_type  __n ) const

inline

Provides access to the data contained in the deque.

Parameters

__n	The index of the element for which data should be accessed.

Returns

Read-only (constant) reference to data.

Exceptions

std::out_of_range

If __n is an invalid index.

This function provides for safer data access. The parameter is first checked that it is in the range of the deque. The function throws out_of_range if the check fails.

Definition at line 1391 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_range_check().

back() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reference std::deque< _Tp, _Alloc >::back ( ) const

inlinenoexcept

Returns a read-only (constant) reference to the data at the last element of the deque.

Definition at line 1437 of file stl_deque.h.

back() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

reference std::deque< _Tp, _Alloc >::back ( )

inlinenoexcept

Returns a read/write reference to the data at the last element of the deque.

Definition at line 1424 of file stl_deque.h.

begin() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_iterator std::deque< _Tp, _Alloc >::begin ( ) const

inlinenoexcept

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 1133 of file stl_deque.h.

begin() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::begin ( )

inlinenoexcept

Returns a read/write iterator that points to the first element in the deque. Iteration is done in ordinary element order.

Definition at line 1125 of file stl_deque.h.

Referenced by std::deque< _Tp, _Alloc >::deque(), std::deque< _Tp, _Alloc >::~deque(), std::deque< _Tp, _Alloc >::clear(), std::deque< _Tp, _Alloc >::insert(), std::operator<(), std::deque< _Tp, _Alloc >::operator=(), and std::operator==().

cbegin()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_iterator std::deque< _Tp, _Alloc >::cbegin ( ) const

inlinenoexcept

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 1196 of file stl_deque.h.

Referenced by std::deque< _Tp, _Alloc >::insert().

cend()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_iterator std::deque< _Tp, _Alloc >::cend ( ) const

inlinenoexcept

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 1205 of file stl_deque.h.

clear()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::clear ( )

inlinenoexcept

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 1790 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::begin().

crbegin()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reverse_iterator std::deque< _Tp, _Alloc >::crbegin ( ) const

inlinenoexcept

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 1214 of file stl_deque.h.

crend()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reverse_iterator std::deque< _Tp, _Alloc >::crend ( ) const

inlinenoexcept

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 1223 of file stl_deque.h.

emplace()

template<typename _Tp , typename _Alloc >

template<typename... _Args>

deque< _Tp, _Alloc >::iterator deque::emplace	(	const_iterator	__position,
		_Args &&...	__args
	)

Inserts an object in deque before specified iterator.

Parameters

__position	A const_iterator into the deque.
__args	Arguments.

Returns

An iterator that points to the inserted data.

This function will insert an object of type T constructed with T(std::forward<Args>(args)...) before the specified location.

Definition at line 187 of file deque.tcc.

Referenced by std::deque< _Tp, _Alloc >::insert().

empty()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

bool std::deque< _Tp, _Alloc >::empty ( ) const

inlinenoexcept

Returns true if the deque is empty. (Thus begin() would equal end().)

Definition at line 1308 of file stl_deque.h.

end() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_iterator std::deque< _Tp, _Alloc >::end ( ) const

inlinenoexcept

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 1151 of file stl_deque.h.

end() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::end ( )

inlinenoexcept

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 1142 of file stl_deque.h.

Referenced by std::deque< _Tp, _Alloc >::deque(), std::deque< _Tp, _Alloc >::~deque(), std::operator<(), std::deque< _Tp, _Alloc >::operator=(), and std::operator==().

erase() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::erase ( const_iterator  __first, const_iterator  __last  )

inline

Remove a range of elements.

Parameters

__first	Iterator pointing to the first element to be erased.
__last	Iterator pointing to one past the last element to be erased.

Returns

An iterator pointing to the element pointed to by last prior to erasing (or end()).

This function will erase the elements in the range [__first,__last) and shorten the deque accordingly.

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 1754 of file stl_deque.h.

erase() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::erase ( const_iterator  __position )

inline

Remove element at given position.

Parameters

__position

Iterator pointing to element to be erased.

Returns

An iterator pointing to the next element (or end()).

This function will erase the element at the given position and thus shorten the deque by one.

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 1730 of file stl_deque.h.

front() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reference std::deque< _Tp, _Alloc >::front ( ) const

inlinenoexcept

Returns a read-only (constant) reference to the data at the first element of the deque.

Definition at line 1413 of file stl_deque.h.

front() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

reference std::deque< _Tp, _Alloc >::front ( )

inlinenoexcept

Returns a read/write reference to the data at the first element of the deque.

Definition at line 1402 of file stl_deque.h.

get_allocator()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

allocator_type std::deque< _Tp, _Alloc >::get_allocator ( ) const

inlinenoexcept

Get a copy of the memory allocation object.

Definition at line 1116 of file stl_deque.h.

Referenced by std::deque< _Tp, _Alloc >::operator=().

insert() [1/5]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::insert ( const_iterator  __p, initializer_list< value_type >  __l  )

inline

Inserts an initializer list into the deque.

Parameters

__p	An iterator into the deque.
__l	An initializer_list.

Returns

An iterator that points to the inserted data.

This function will insert copies of the data in the initializer_list __l into the deque before the location specified by __p. This is known as list insert.

Definition at line 1630 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::cbegin().

insert() [2/5]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>>

iterator std::deque< _Tp, _Alloc >::insert ( const_iterator  __position, _InputIterator  __first, _InputIterator  __last  )

inline

Inserts a range into the deque.

Parameters

__position	A const_iterator into the deque.
__first	An input iterator.
__last	An input iterator.

Returns

An iterator that points to the inserted data.

This function will insert copies of the data in the range [__first,__last) into the deque before the location specified by __position. This is known as range insert.

Definition at line 1685 of file stl_deque.h.

References std::__iterator_category(), std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::cbegin().

insert() [3/5]

template<typename _Tp , typename _Alloc >

deque< _Tp, _Alloc >::iterator deque::insert	(	const_iterator	__position,
		const value_type &	__x
	)

Inserts given value into deque before specified iterator.

Parameters

__position	A const_iterator into the deque.
__x	Data to be inserted.

Returns

An iterator that points to the inserted data.

This function will insert a copy of the given value before the specified location.

Definition at line 210 of file deque.tcc.

insert() [4/5]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::insert ( const_iterator  __position, size_type  __n, const value_type &  __x  )

inline

Inserts a number of copies of given data into the deque.

Parameters

__position	A const_iterator into the deque.
__n	Number of elements to be inserted.
__x	Data to be inserted.

Returns

An iterator that points to the inserted data.

This function will insert a specified number of copies of the given data before the location specified by __position.

Definition at line 1649 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::begin(), and std::deque< _Tp, _Alloc >::cbegin().

insert() [5/5]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

iterator std::deque< _Tp, _Alloc >::insert ( const_iterator  __position, value_type &&  __x  )

inline

Inserts given rvalue into deque before specified iterator.

Parameters

__position	A const_iterator into the deque.
__x	Data to be inserted.

Returns

An iterator that points to the inserted data.

This function will insert a copy of the given rvalue before the specified location.

Definition at line 1616 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::emplace(), and std::move().

max_size()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

size_type std::deque< _Tp, _Alloc >::max_size ( ) const

inlinenoexcept

Returns the size() of the largest possible deque.

Definition at line 1235 of file stl_deque.h.

operator=() [1/3]

template<typename _Tp , typename _Alloc >

deque< _Tp, _Alloc > & deque::operator=

(

const deque< _Tp, _Alloc > &

__x

)

Deque assignment operator.

Parameters

__x	A deque of identical element and allocator types.

All the elements of x are copied.

The newly-created deque uses a copy of the allocator object used by __x (unless the allocator traits dictate a different object).

Definition at line 95 of file deque.tcc.

References std::deque< _Tp, _Alloc >::begin(), std::deque< _Tp, _Alloc >::end(), std::deque< _Tp, _Alloc >::get_allocator(), and std::deque< _Tp, _Alloc >::size().

operator=() [2/3]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

deque& std::deque< _Tp, _Alloc >::operator= ( deque< _Tp, _Alloc > &&  __x )

inlinenoexcept

Deque move assignment operator.

Parameters

__x	A deque of identical element and allocator types.

The contents of __x are moved into this deque (without copying, if the allocators permit it). __x is a valid, but unspecified deque.

Definition at line 1028 of file stl_deque.h.

References std::move().

operator=() [3/3]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

deque& std::deque< _Tp, _Alloc >::operator= ( initializer_list< value_type >  __l )

inline

Assigns an initializer list to a deque.

Parameters

__l	An initializer_list.

This function fills a deque with copies of the elements in the initializer_list __l.

Note that the assignment completely changes the deque and that the resulting deque's size is the same as the number of elements assigned.

Definition at line 1047 of file stl_deque.h.

operator[]() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reference std::deque< _Tp, _Alloc >::operator[] ( size_type  __n ) const

inlinenoexcept

Subscript access to the data contained in the deque.

Parameters

__n	The index of the element for which data should be accessed.

Returns

Read-only (constant) reference to data.

This operator allows for easy, array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined. (For checked lookups see at().)

Definition at line 1342 of file stl_deque.h.

operator[]() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

reference std::deque< _Tp, _Alloc >::operator[] ( size_type  __n )

inlinenoexcept

Subscript access to the data contained in the deque.

Parameters

__n	The index of the element for which data should be accessed.

Returns

Read/write reference to data.

This operator allows for easy, array-style, data access. Note that data access with this operator is unchecked and out_of_range lookups are not defined. (For checked lookups see at().)

Definition at line 1324 of file stl_deque.h.

pop_back()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::pop_back ( )

inlinenoexcept

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 1552 of file stl_deque.h.

pop_front()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::pop_front ( )

inlinenoexcept

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 1529 of file stl_deque.h.

push_back()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::push_back ( const value_type &  __x )

inline

Add data to the end of the deque.

Parameters

__x	Data to be added.

This is a typical stack operation. The function creates an element at the end of the deque and assigns the given data to it. Due to the nature of a deque this operation can be done in constant time.

Definition at line 1493 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_push_back_aux().

push_front()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::push_front ( const value_type &  __x )

inline

Add data to the front of the deque.

Parameters

__x	Data to be added.

This is a typical stack operation. The function creates an element at the front of the deque and assigns the given data to it. Due to the nature of a deque this operation can be done in constant time.

Definition at line 1456 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::_M_push_front_aux().

rbegin() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reverse_iterator std::deque< _Tp, _Alloc >::rbegin ( ) const

inlinenoexcept

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 1169 of file stl_deque.h.

rbegin() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

reverse_iterator std::deque< _Tp, _Alloc >::rbegin ( )

inlinenoexcept

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 1160 of file stl_deque.h.

rend() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

const_reverse_iterator std::deque< _Tp, _Alloc >::rend ( ) const

inlinenoexcept

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 1187 of file stl_deque.h.

rend() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

reverse_iterator std::deque< _Tp, _Alloc >::rend ( )

inlinenoexcept

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 1178 of file stl_deque.h.

resize() [1/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::resize ( size_type  __new_size )

inline

Resizes the deque to the specified number of elements.

Parameters

__new_size

Number of elements the deque should contain.

This function will resize the deque to the specified number of elements. If the number is smaller than the deque's current size the deque is truncated, otherwise default constructed elements are appended.

Definition at line 1249 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::size().

resize() [2/2]

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::resize ( size_type  __new_size, const value_type &  __x  )

inline

Resizes the deque to the specified number of elements.

Parameters

__new_size	Number of elements the deque should contain.
__x	Data with which new elements should be populated.

This function will resize the deque to the specified number of elements. If the number is smaller than the deque's current size the deque is truncated, otherwise the deque is extended and new elements are populated with given data.

Definition at line 1271 of file stl_deque.h.

References std::deque< _Tp, _Alloc >::size().

shrink_to_fit()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::shrink_to_fit ( )

inlinenoexcept

A non-binding request to reduce memory use.

Definition at line 1299 of file stl_deque.h.

size()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

size_type std::deque< _Tp, _Alloc >::size ( ) const

inlinenoexcept

Returns the number of elements in the deque.

Definition at line 1230 of file stl_deque.h.

Referenced by std::deque< _Tp, _Alloc >::_M_range_check(), std::deque< _Tp, _Alloc >::operator=(), std::operator==(), and std::deque< _Tp, _Alloc >::resize().

swap()

template<typename _Tp , typename _Alloc = std::allocator<_Tp>>

void std::deque< _Tp, _Alloc >::swap ( deque< _Tp, _Alloc > &  __x )

inlinenoexcept

Swaps data with another deque.

Parameters

__x	A deque of the same element and allocator types.

This exchanges the elements between two deques in constant time. (Four pointers, so it should be quite fast.) Note that the global std::swap() function is specialized such that std::swap(d1,d2) will feed to this function.

Whether the allocators are swapped depends on the allocator traits.

Definition at line 1772 of file stl_deque.h.

---

The documentation for this class was generated from the following files:

• stl_deque.h
• deque.tcc