deque Class Template Reference
[ContainersSequences]

#include <stl_deque.h>

List of all members.


Detailed Description

template<typename Type, typename Alloc = allocator<Type>>
class std::deque< Type, Alloc >

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions


Constructor & Destructor Documentation

deque const allocator_type &  a = allocator_type()  )  [inline, explicit]
 

Default constructor creates no elements.

Definition at line 640 of file stl_deque.h.

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

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

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

References deque::begin(), deque::end(), deque::get_allocator(), and deque::size().

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

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


Member Function Documentation

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

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

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

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

const_reference back  )  const [inline]
 

Returns a read-only (constant) reference to the data at the last element of the deque. Definition at line 983 of file stl_deque.h.

reference back  )  [inline]
 

Returns a read/write reference to the data at the last element of the deque. Definition at line 971 of file stl_deque.h.

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

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

Referenced by deque::deque(), deque::operator=(), and std::operator==().

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

Referenced by deque::erase().

bool empty  )  const [inline]
 

Returns true if the deque is empty. (Thus begin() would equal end().) Definition at line 876 of file stl_deque.h.

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

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

Referenced by deque::deque(), deque::operator=(), and std::operator==().

deque< Type, Alloc >::iterator 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 deque::clear(), std::copy(), std::copy_backward(), and deque::size().

deque< Type, Alloc >::iterator 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(), deque::pop_back(), and deque::pop_front().

Referenced by deque::operator=(), and deque::resize().

const_reference front  )  const [inline]
 

Returns a read-only (constant) reference to the data at the first element of the deque. Definition at line 963 of file stl_deque.h.

reference front  )  [inline]
 

Returns a read/write reference to the data at the first element of the deque. Definition at line 955 of file stl_deque.h.

allocator_type get_allocator  )  const [inline]
 

Get a copy of the memory allocation object.

Definition at line 758 of file stl_deque.h.

Referenced by deque::deque().

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

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

deque< Type, Alloc >::iterator 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 deque::push_back(), and deque::push_front().

Referenced by deque::operator=(), and deque::resize().

size_type max_size  )  const [inline]
 

Returns the size() of the largest possible deque. Definition at line 836 of file stl_deque.h.

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 deque::begin(), std::copy(), deque::end(), deque::erase(), deque::insert(), and deque::size().

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

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

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

Referenced by deque::erase().

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

Referenced by deque::erase().

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

Referenced by deque::insert().

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

Referenced by deque::insert().

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

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

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

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

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

References deque::resize().

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

References deque::erase(), deque::insert(), and deque::size().

Referenced by deque::resize().

size_type size  )  const [inline]
 

Returns the number of elements in the deque. Definition at line 831 of file stl_deque.h.

Referenced by deque::deque(), deque::erase(), deque::operator=(), std::operator==(), and deque::resize().

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

References std::swap().

Referenced by std::swap().


The documentation for this class was generated from the following files:
Generated on Sun Sep 12 15:50:15 2004 for libstdc++ source by doxygen 1.3.8