std::deque(3)

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

SYNOPSIS

#include <deque>

Inherits std::_Deque_base< _Tp, _Alloc >.

  Public Member Functions
deque (const allocator_type &__a=allocator_type())
Default constructor creates no elements.
deque (size_type __n, const value_type &__value, const allocator_type &__a=allocator_type())
Create a deque with copies of an exemplar element.
deque (size_type __n)
Create a deque with default elements.
deque (const deque &__x)
Deque copy constructor.
template<typename _InputIterator> deque (_InputIterator __first, _InputIterator __last, const allocator_type &__a=allocator_type())
Builds a deque from a range.
~deque ()
deque & operator= (const deque &__x)
Deque assignment operator.
void assign (size_type __n, const value_type &__val)
Assigns a given value to a deque.
template<typename _InputIterator> void assign (_InputIterator __first, _InputIterator __last)
Assigns a range to a deque.
allocator_type get_allocator () const
Get a copy of the memory allocation object.
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
reverse_iterator rbegin ()
const_reverse_iterator rbegin () const
reverse_iterator rend ()
const_reverse_iterator rend () const
size_type size () const
size_type max_size () const
void resize (size_type __new_size, const value_type &__x)
Resizes the deque to the specified number of elements.
void resize (size_type new_size)
Resizes the deque to the specified number of elements.
bool empty () const
reference operator[] (size_type __n)
Subscript access to the data contained in the deque.
const_reference operator[] (size_type __n) const
Subscript access to the data contained in the deque.
reference at (size_type __n)
Provides access to the data contained in the deque.
const_reference at (size_type __n) const
Provides access to the data contained in the deque.
reference front ()
const_reference front () const
reference back ()
const_reference back () const
void push_front (const value_type &__x)
Add data to the front of the deque.
void push_front ()
Add data to the front of the deque.
void push_back (const value_type &__x)
Add data to the end of the deque.
void push_back ()
Add data to the end of the deque.
void pop_front ()
Removes first element.
void pop_back ()
Removes last element.
iterator insert (iterator position, const value_type &__x)
Inserts given value into deque before specified iterator.
iterator insert (iterator __position)
Inserts an element into the deque.
void insert (iterator __position, size_type __n, const value_type &__x)
Inserts a number of copies of given data into the deque.
template<typename _InputIterator> void insert (iterator __pos, _InputIterator __first, _InputIterator __last)
Inserts a range into the deque.
iterator erase (iterator __position)
Remove element at given position.
iterator erase (iterator __first, iterator __last)
Remove a range of elements.
void swap (deque &__x)
Swaps data with another deque.
void clear ()

Detailed Description

  template<typename _Tp, typename _Alloc = allocator<_Tp>> class std::deque< _Tp, _Alloc >
A standard container using fixed-size memory allocation and constant-time manipulation of elements at either end. 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.

Definition at line 635 of file deque.

Constructor & Destructor Documentation

  template<typename _Tp, typename _Alloc = allocator<_Tp>> std::deque< _Tp, _Alloc >::deque (const allocator_type & __a = allocator_type()) [inline, explicit]

Default constructor creates no elements.

Definition at line 687 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> std::deque< _Tp, _Alloc >::deque (size_type __n, const value_type & __value, const allocator_type & __a = allocator_type()) [inline]

Create a deque with copies of an exemplar element.Parameters:
    n The number of elements to initially create.
    value An element to copy.

This constructor fills the deque with n copies of value.

Definition at line 697 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> std::deque< _Tp, _Alloc >::deque (size_type __n) [inline, explicit]

Create a deque with default elements.Parameters:
    n The number of elements to initially create.

This constructor fills the deque with n copies of a default-constructed element.

Definition at line 710 of file deque.

  template<typename _Tp, typename _Alloc = 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 allocation object used by x.

Definition at line 721 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> template<typename _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.

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

  template<typename _Tp, typename _Alloc = 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 responsibilty.

Definition at line 753 of file deque.

Member Function Documentation

  template<typename _Tp, typename _Alloc = allocator<_Tp>> template<typename _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. Old data may be lost.

Definition at line 792 of file deque.

  template<typename _Tp, typename _Alloc = 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. Old data may be lost.

Definition at line 776 of file deque.

  template<typename _Tp, typename _Alloc = 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 966 of file deque.

  template<typename _Tp, typename _Alloc = 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 953 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 999 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 987 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 815 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 808 of file deque.

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

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

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 responsibilty.

Definition at line 165 of file deque.tcc.

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> bool std::deque< _Tp, _Alloc >::empty () const [inline]

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

Definition at line 905 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 829 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 822 of file deque.

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

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

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 responsibilty.

Definition at line 131 of file deque.tcc.

References std::deque< _Tp, _Alloc >::clear(), std::copy(), std::copy_backward(), and std::deque< _Tp, _Alloc >::size().

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

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 responsibilty.

Definition at line 110 of file deque.tcc.

References std::copy(), std::copy_backward(), std::deque< _Tp, _Alloc >::pop_back(), and std::deque< _Tp, _Alloc >::pop_front().

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 980 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 973 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> allocator_type std::deque< _Tp, _Alloc >::get_allocator () const [inline]

Get a copy of the memory allocation object.

Definition at line 800 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> template<typename _InputIterator> void std::deque< _Tp, _Alloc >::insert (iterator __pos, _InputIterator __first, _InputIterator __last) [inline]

Inserts a range into the deque.Parameters:
    pos An iterator into the deque.
    first An input iterator.
    last An input iterator.

This function will insert copies of the data in the range [first,last) into the deque before the location specified by pos. This is known as 'range insert.'

Definition at line 1189 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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.Parameters:
    position An iterator into the deque.
    n Number of elements to be inserted.
    x Data to be inserted.

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

Definition at line 1174 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> iterator std::deque< _Tp, _Alloc >::insert (iterator __position) [inline]

Inserts an element into the deque.Parameters:
    position An iterator into the deque.

Returns:
    An iterator that points to the inserted element.

This function will insert a default-constructed element before the specified location. You should consider using insert(position,value_type()) instead.

Note:
    This was deprecated in 3.2 and will be removed in 3.4. You must define _GLIBCPP_DEPRECATED to make this visible in 3.2; see c++config.h.

Definition at line 1160 of file deque.

  template<typename _Tp, typename _Alloc> deque< _Tp, _Alloc >::iterator std::deque< _Tp, _Alloc >::insert (iterator position, const value_type & __x)

Inserts given value into deque before specified iterator.Parameters:
    position An 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 89 of file deque.tcc.

References std::deque< _Tp, _Alloc >::push_back(), and std::deque< _Tp, _Alloc >::push_front().

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> size_type std::deque< _Tp, _Alloc >::max_size () const [inline]

Returns the size() of the largest possible deque.

Definition at line 868 of file deque.

  template<typename _Tp, typename _Alloc> deque< _Tp, _Alloc > & std::deque< _Tp, _Alloc >::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, but unlike the copy constructor, the allocator object is not copied.

Definition at line 69 of file deque.tcc.

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> const_reference std::deque< _Tp, _Alloc >::operator[] (size_type __n) const [inline]

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> reference std::deque< _Tp, _Alloc >::operator[] (size_type __n) [inline]

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 1123 of file deque.

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 1104 of file deque.

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> void std::deque< _Tp, _Alloc >::push_back () [inline]

Add data to the end of the deque.This is a typical stack operation. The function creates a default-constructed element at the end of the deque. Due to the nature of a deque this operation can be done in constant time. You should consider using push_back(value_type()) instead.

Note:
    This was deprecated in 3.2 and will be removed in 3.4. You must define _GLIBCPP_DEPRECATED to make this visible in 3.2; see c++config.h.

Definition at line 1084 of file deque.

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

  template<typename _Tp, typename _Alloc = 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 1060 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> void std::deque< _Tp, _Alloc >::push_front () [inline]

Add data to the front of the deque.This is a typical stack operation. The function creates a default-constructed element at the front of the deque. Due to the nature of a deque this operation can be done in constant time. You should consider using push_front(value_type()) instead.

Note:
    This was deprecated in 3.2 and will be removed in 3.4. You must define _GLIBCPP_DEPRECATED to make this visible in 3.2; see c++config.h.

Definition at line 1040 of file deque.

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

  template<typename _Tp, typename _Alloc = 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 1016 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 843 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 836 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 859 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> 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 851 of file deque.

  template<typename _Tp, typename _Alloc = 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 the deque is extended and new elements are default-constructed.

Definition at line 900 of file deque.

  template<typename _Tp, typename _Alloc = 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 881 of file deque.

  template<typename _Tp, typename _Alloc = allocator<_Tp>> size_type std::deque< _Tp, _Alloc >::size () const [inline]

Returns the number of elements in the deque.

Definition at line 864 of file deque.

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

  template<typename _Tp, typename _Alloc = allocator<_Tp>> void std::deque< _Tp, _Alloc >::swap (deque< _Tp, _Alloc > & __x) [inline]

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.

Definition at line 1241 of file deque.

Author

Generated automatically by Doxygen for libstdc++-v3 Source from the source code.