man std::deque (Fonctions bibliothèques) - A standard container using fixed-size memory allocation and constant-time manipulation of elements at either end.

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< Type, Alloc >< Type, Alloc >.

Public Types

typedef Type value_type

typedef Alloc::pointer pointer

typedef Alloc::const_pointer const_pointer

typedef Alloc::reference reference

typedef Alloc::const_reference const_reference

typedef Base::iterator iterator

typedef Base::const_iterator const_iterator

typedef std::reverse_iterator< const_iterator > const_reverse_iterator

typedef std::reverse_iterator< iterator > reverse_iterator

typedef size_t size_type

typedef ptrdiff_t difference_type

typedef Base::allocator_type allocator_type

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_back (const value_type &x)

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. 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 position, 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 ()

Protected Types

typedef pointer * Map_pointer

typedef Alloc::template rebind< Type * >::other Map_alloc_type

enum

Protected Member Functions

void M_range_check (size_type n) const

template<typename Integer> void M_initialize_dispatch (Integer n, Integer x, __true_type)

template<typename InputIterator> void M_initialize_dispatch (InputIterator first, InputIterator last, __false_type)

void M_fill_initialize (const value_type &value)

template<typename Integer> void M_assign_dispatch (Integer n, Integer __val, __true_type)

template<typename InputIterator> void M_assign_dispatch (InputIterator first, InputIterator last, __false_type)

template<typename InputIterator> void M_assign_aux (InputIterator first, InputIterator last, input_iterator_tag)

template<typename ForwardIterator> void M_assign_aux (ForwardIterator first, ForwardIterator last, forward_iterator_tag)

void M_fill_assign (size_type n, const value_type &__val)

template<typename Integer> void M_insert_dispatch (iterator position, Integer n, Integer x, __true_type)

template<typename InputIterator> void M_insert_dispatch (iterator position, InputIterator first, InputIterator last, __false_type)

template<typename InputIterator> void M_range_insert_aux (iterator position, InputIterator first, InputIterator last, input_iterator_tag)

template<typename ForwardIterator> void M_range_insert_aux (iterator position, ForwardIterator first, ForwardIterator last, forward_iterator_tag)

void M_fill_insert (iterator position, size_type n, const value_type &x)

iterator M_insert_aux (iterator position, const value_type &x)

void M_insert_aux (iterator position, size_type n, const value_type &x)

template<typename ForwardIterator> void M_insert_aux (iterator position, ForwardIterator first, ForwardIterator last, size_type n)

Map_alloc_type M_get_map_allocator () const

Type * M_allocate_node ()

void M_deallocate_node (Type *__p)

Type ** M_allocate_map (size_t n)

void M_deallocate_map (Type **__p, size_t n)

void M_initialize_map (size_t)

void M_create_nodes (Type **nstart, Type **nfinish)

void M_destroy_nodes (Type **nstart, Type **nfinish)



template<typename InputIterator> void M_range_initialize (InputIterator first, InputIterator last, input_iterator_tag)

template<typename ForwardIterator> void M_range_initialize (ForwardIterator first, ForwardIterator last, forward_iterator_tag)



void M_push_back_aux (const value_type &)

void M_push_front_aux (const value_type &)

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_buffer_size ()

Protected Attributes

Deque_impl M_impl

Private Types

typedef Deque_base< Type, Alloc > Base

Detailed Description

template<typename Type, typename Alloc = allocator<Type>> class std::deque< Type, 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 585 of file deque.

Constructor & Destructor Documentation

template<typename Type, typename Alloc = allocator<Type>> std::deque< Type, Alloc >::deque (const allocator_type & a = allocator_type()) [inline, explicit]

Default constructor creates no elements.

Definition at line 635 of file deque.

template<typename Type, typename Alloc = allocator<Type>> std::deque< Type, 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 645 of file deque.

template<typename Type, typename Alloc = allocator<Type>> std::deque< Type, 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 658 of file deque.

template<typename Type, typename Alloc = allocator<Type>> std::deque< Type, Alloc >::deque (const deque< Type, 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 669 of file deque.

template<typename Type, typename Alloc = allocator<Type>> template<typename InputIterator> std::deque< Type, 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 688 of file deque.

template<typename Type, typename Alloc = allocator<Type>> std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 702 of file deque.

Member Function Documentation

template<typename Type, typename Alloc = allocator<Type>> template<typename InputIterator> void std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 743 of file deque.

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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 726 of file deque.

template<typename Type, typename Alloc = allocator<Type>> const_reference std::deque< Type, 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 934 of file deque.

template<typename Type, typename Alloc = allocator<Type>> reference std::deque< Type, 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 920 of file deque.

template<typename Type, typename Alloc = allocator<Type>> const_reference std::deque< Type, Alloc >::back () const [inline]

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

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 973 of file deque.

template<typename Type, typename Alloc = allocator<Type>> reference std::deque< Type, Alloc >::back () [inline]

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

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 961 of file deque.

Referenced by std::deque< Type, Alloc >::M_insert_aux().

template<typename Type, typename Alloc = allocator<Type>> const_iterator std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 768 of file deque.

template<typename Type, typename Alloc = allocator<Type>> iterator std::deque< Type, Alloc >::begin () [inline]

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

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 760 of file deque.

Referenced by std::deque< Type, Allocator >::deque(), std::deque< Type, Allocator >::M_assign_aux(), std::deque< Type, Allocator >::M_fill_assign(), std::deque< Type, Alloc >::operator=(), and std::operator==().

template<typename Type, typename Alloc> void std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 167 of file deque.tcc.

Referenced by std::deque< Type, Alloc >::erase(), and std::deque< Type, Alloc >::M_range_initialize().

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

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

Definition at line 869 of file deque.

template<typename Type, typename Alloc = allocator<Type>> const_iterator std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 784 of file deque.

template<typename Type, typename Alloc = allocator<Type>> iterator std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 776 of file deque.

Referenced by std::deque< Type, Allocator >::deque(), std::deque< Type, Allocator >::M_assign_aux(), std::deque< Type, Allocator >::M_fill_assign(), std::deque< Type, Alloc >::operator=(), and std::operator==().

template<typename Type, typename Alloc> deque< Type, Alloc >::iterator std::deque< Type, 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 132 of file deque.tcc.

References std::deque< Type, Alloc >::clear(), std::copy(), std::copy_backward(), and std::deque< Type, Alloc >::size().

template<typename Type, typename Alloc> deque< Type, Alloc >::iterator std::deque< Type, 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 111 of file deque.tcc.

References std::copy(), std::copy_backward(), std::deque< Type, Alloc >::pop_back(), std::deque< Type, Alloc >::pop_front(), and std::deque< Type, Alloc >::size().

Referenced by std::deque< Type, Allocator >::M_assign_aux(), std::deque< Type, Allocator >::M_fill_assign(), std::deque< Type, Alloc >::operator=(), and std::deque< Type, Allocator >::resize().

template<typename Type, typename Alloc = allocator<Type>> const_reference std::deque< Type, Alloc >::front () const [inline]

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

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 953 of file deque.

template<typename Type, typename Alloc = allocator<Type>> reference std::deque< Type, Alloc >::front () [inline]

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

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 945 of file deque.

Referenced by std::deque< Type, Alloc >::M_insert_aux().

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

Get a copy of the memory allocation object.

Reimplemented from std::Deque_base< Type, Alloc >.

Definition at line 751 of file deque.

template<typename Type, typename Alloc = allocator<Type>> template<typename InputIterator> void std::deque< Type, Alloc >::insert (iterator position, InputIterator first, InputIterator last) [inline]

Inserts a range into the deque.

Parameters: position 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 1098 of file deque.

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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 1083 of file deque.

template<typename Type, typename Alloc> deque< Type, Alloc >::iterator std::deque< Type, 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 90 of file deque.tcc.

References std::deque< Type, Alloc >::push_back(), and std::deque< Type, Alloc >::push_front().

Referenced by std::deque< Type, Allocator >::M_assign_aux(), std::deque< Type, Allocator >::M_fill_assign(), std::deque< Type, Alloc >::operator=(), and std::deque< Type, Allocator >::resize().

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

Returns the size() of the largest possible deque.

Definition at line 829 of file deque.

template<typename Type, typename Alloc> deque< Type, Alloc > & std::deque< Type, Alloc >::operator= (const deque< Type, 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< Type, Alloc >::begin(), std::copy(), std::deque< Type, Alloc >::end(), std::deque< Type, Alloc >::erase(), std::deque< Type, Alloc >::insert(), and std::deque< Type, Alloc >::size().

template<typename Type, typename Alloc = allocator<Type>> const_reference std::deque< Type, 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 896 of file deque.

template<typename Type, typename Alloc = allocator<Type>> reference std::deque< Type, 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 883 of file deque.

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 1050 of file deque.

Referenced by std::deque< Type, Alloc >::erase().

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 1030 of file deque.

Referenced by std::deque< Type, Alloc >::erase().

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 1010 of file deque.

Referenced by std::deque< Type, Alloc >::insert(), std::deque< Type, Alloc >::M_insert_aux(), and std::deque< Type, Alloc >::M_range_initialize().

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 990 of file deque.

Referenced by std::deque< Type, Alloc >::insert(), and std::deque< Type, Alloc >::M_insert_aux().

template<typename Type, typename Alloc = allocator<Type>> const_reverse_iterator std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 801 of file deque.

template<typename Type, typename Alloc = allocator<Type>> reverse_iterator std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 792 of file deque.

template<typename Type, typename Alloc = allocator<Type>> const_reverse_iterator std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 818 of file deque.

template<typename Type, typename Alloc = allocator<Type>> reverse_iterator std::deque< Type, 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.

Reimplemented in __gnu_debug_def::deque< Type, Allocator >.

Definition at line 810 of file deque.

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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 862 of file deque.

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, 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 843 of file deque.

Referenced by std::deque< Type, Allocator >::resize().

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

Returns the number of elements in the deque.

Definition at line 824 of file deque.

Referenced by std::deque< Type, Alloc >::erase(), std::deque< Type, Allocator >::M_assign_aux(), std::deque< Type, Allocator >::M_fill_assign(), std::deque< Type, Alloc >::M_insert_aux(), std::deque< Type, Alloc >::operator=(), std::operator==(), and std::deque< Type, Allocator >::resize().

template<typename Type, typename Alloc = allocator<Type>> void std::deque< Type, Alloc >::swap (deque< Type, 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 1151 of file deque.

Referenced by std::swap().

Author

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