libstdc++
std::vector Class Reference
Inheritance diagram for std::vector:

List of all members.

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes


Detailed Description

A standard container which offers fixed time access to individual elements in any order.

Meets the requirements of a container, a reversible container, and a sequence, including the optional sequence requirements with the exception of push_front and pop_front.

In some terminology a vector can be described as a dynamic C-style array, it offers fast and efficient access to individual elements in any order and saves the user from worrying about memory and size allocation. Subscripting ( [] ) access is also provided as with C-style arrays.


Constructor & Destructor Documentation

std::vector::vector ( ) [inline]

Default constructor creates no elements.

Definition at line 217 of file stl_vector.h.

std::vector::vector ( const allocator_type &  __a) [inline, explicit]

Creates a vector with no elements.

Parameters:
aAn allocator object.

Definition at line 225 of file stl_vector.h.

std::vector::vector ( size_type  __n) [inline, explicit]

Creates a vector with default constructed elements.

Parameters:
nThe number of elements to initially create.

This constructor fills the vector with n default constructed elements.

Definition at line 237 of file stl_vector.h.

std::vector::vector ( size_type  __n,
const value_type &  __value,
const allocator_type &  __a = allocator_type() 
) [inline]

Creates a vector with copies of an exemplar element.

Parameters:
nThe number of elements to initially create.
valueAn element to copy.
aAn allocator.

This constructor fills the vector with n copies of value.

Definition at line 249 of file stl_vector.h.

std::vector::vector ( const vector __x) [inline]

Vector copy constructor.

Parameters:
xA vector of identical element and allocator types.

The newly-created vector uses a copy of the allocation object used by x. All the elements of x are copied, but any extra memory in x (for fast expansion) will not be copied.

Definition at line 278 of file stl_vector.h.

std::vector::vector ( vector &&  __x) [inline]

Vector move constructor.

Parameters:
xA vector of identical element and allocator types.

The newly-created vector contains the exact contents of x. The contents of x are a valid, but unspecified vector.

Definition at line 294 of file stl_vector.h.

std::vector::vector ( initializer_list< value_type >  __l,
const allocator_type &  __a = allocator_type() 
) [inline]

Builds a vector from an initializer list.

Parameters:
lAn initializer_list.
aAn allocator.

Create a vector 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 308 of file stl_vector.h.

template<typename _InputIterator >
std::vector::vector ( _InputIterator  __first,
_InputIterator  __last,
const allocator_type &  __a = allocator_type() 
) [inline]

Builds a vector from a range.

Parameters:
firstAn input iterator.
lastAn input iterator.
aAn allocator.

Create a vector 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 334 of file stl_vector.h.

std::vector::~vector ( ) [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 349 of file stl_vector.h.


Member Function Documentation

template<typename _ForwardIterator >
pointer std::vector::_M_allocate_and_copy ( size_type  __n,
_ForwardIterator  __first,
_ForwardIterator  __last 
) [inline, protected]

Memory expansion handler. Uses the member allocation function to obtain n bytes of memory, and then copies [first,last) into it.

Definition at line 1049 of file stl_vector.h.

void std::vector::_M_range_check ( size_type  __n) const [inline, protected]

Safety check used only from at().

Definition at line 716 of file stl_vector.h.

Referenced by std::vector< _State >::at().

void std::vector::assign ( size_type  __n,
const value_type &  __val 
) [inline]

Assigns a given value to a vector.

Parameters:
nNumber of elements to be assigned.
valValue to be assigned.

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

Definition at line 412 of file stl_vector.h.

Referenced by std::vector< _State >::operator=().

template<typename _InputIterator >
void std::vector::assign ( _InputIterator  __first,
_InputIterator  __last 
) [inline]

Assigns a range to a vector.

Parameters:
firstAn input iterator.
lastAn input iterator.

This function fills a vector with copies of the elements in the range [first,last).

Note that the assignment completely changes the vector and that the resulting vector's size is the same as the number of elements assigned. Old data may be lost.

Definition at line 429 of file stl_vector.h.

void std::vector::assign ( initializer_list< value_type >  __l) [inline]

Assigns an initializer list to a vector.

Parameters:
lAn initializer_list.

This function fills a vector with copies of the elements in the initializer list l.

Note that the assignment completely changes the vector and that the resulting vector's size is the same as the number of elements assigned. Old data may be lost.

Definition at line 449 of file stl_vector.h.

Referenced by std::vector< _State >::assign().

reference std::vector::at ( size_type  __n) [inline]

Provides access to the data contained in the vector.

Parameters:
nThe index of the element for which data should be accessed.
Returns:
Read/write reference to data.
Exceptions:
std::out_of_rangeIf 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 vector. The function throws out_of_range if the check fails.

Definition at line 735 of file stl_vector.h.

const_reference std::vector::at ( size_type  __n) const [inline]

Provides access to the data contained in the vector.

Parameters:
nThe index of the element for which data should be accessed.
Returns:
Read-only (constant) reference to data.
Exceptions:
std::out_of_rangeIf 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 vector. The function throws out_of_range if the check fails.

Definition at line 753 of file stl_vector.h.

reference std::vector::back ( ) [inline]

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

Definition at line 780 of file stl_vector.h.

Referenced by std::piecewise_constant_distribution::max(), and std::piecewise_linear_distribution::max().

const_reference std::vector::back ( ) const [inline]

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

Definition at line 788 of file stl_vector.h.

iterator std::vector::begin ( ) [inline]

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

Definition at line 463 of file stl_vector.h.

Referenced by __gnu_parallel::multiseq_partition(), __gnu_parallel::multiseq_selection(), __gnu_parallel::multiway_merge_exact_splitting(), std::vector< _State >::rend(), std::vector< _State >::crend(), std::vector< _State >::empty(), and std::vector< _State >::front().

const_iterator std::vector::begin ( ) const [inline]

Returns a read-only (constant) iterator that points to the first element in the vector. Iteration is done in ordinary element order.

Reimplemented in std::match_results.

Definition at line 472 of file stl_vector.h.

size_type std::vector::capacity ( ) const [inline]

Returns the total number of elements that the vector can hold before needing to allocate more memory.

Definition at line 650 of file stl_vector.h.

const_iterator std::vector::cbegin ( ) const [inline]

Returns a read-only (constant) iterator that points to the first element in the vector. Iteration is done in ordinary element order.

Reimplemented in std::match_results.

Definition at line 536 of file stl_vector.h.

const_iterator std::vector::cend ( ) const [inline]

Returns a read-only (constant) iterator that points one past the last element in the vector. Iteration is done in ordinary element order.

Reimplemented in std::match_results.

Definition at line 545 of file stl_vector.h.

void std::vector::clear ( ) [inline]

Erases all the elements. Note that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.

Definition at line 1039 of file stl_vector.h.

Referenced by std::vector< _State >::operator=().

const_reverse_iterator std::vector::crbegin ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to the last element in the vector. Iteration is done in reverse element order.

Definition at line 554 of file stl_vector.h.

const_reverse_iterator std::vector::crend ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to one before the first element in the vector. Iteration is done in reverse element order.

Definition at line 563 of file stl_vector.h.

_Tp* std::vector::data ( ) [inline]

Returns a pointer such that [data(), data() + size()) is a valid range. For a non-empty vector, data() == &front().

Definition at line 803 of file stl_vector.h.

template<typename... _Args>
vector< _Tp, _Alloc >::iterator vector::emplace ( iterator  __position,
_Args &&...  __args 
)

Inserts an object in vector before specified iterator.

Parameters:
positionAn iterator into the vector.
argsArguments.
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. Note that this kind of operation could be expensive for a vector and if it is frequently used the user should consider using std::list.

Definition at line 277 of file vector.tcc.

References std::begin(), and std::end().

Referenced by std::vector< _State >::insert().

iterator std::vector::end ( ) [inline]
const_iterator std::vector::end ( ) const [inline]

Returns a read-only (constant) iterator that points one past the last element in the vector. Iteration is done in ordinary element order.

Reimplemented in std::match_results.

Definition at line 490 of file stl_vector.h.

vector< _Tp, _Alloc >::iterator vector::erase ( iterator  __position)

Remove element at given position.

Parameters:
positionIterator 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 vector by one.

Note This operation could be expensive and if it is frequently used the user should consider using std::list. The user is also cautioned that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.

Definition at line 136 of file vector.tcc.

References std::end().

vector< _Tp, _Alloc >::iterator vector::erase ( iterator  __first,
iterator  __last 
)

Remove a range of elements.

Parameters:
firstIterator pointing to the first element to be erased.
lastIterator 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 vector accordingly.

Note This operation could be expensive and if it is frequently used the user should consider using std::list. The user is also 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 148 of file vector.tcc.

References std::end().

reference std::vector::front ( ) [inline]

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

Definition at line 764 of file stl_vector.h.

Referenced by std::piecewise_constant_distribution::min(), std::piecewise_linear_distribution::min(), and std::vector< _State >::data().

const_reference std::vector::front ( ) const [inline]

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

Definition at line 772 of file stl_vector.h.

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

Inserts given value into vector before specified iterator.

Parameters:
positionAn iterator into the vector.
xData 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. Note that this kind of operation could be expensive for a vector and if it is frequently used the user should consider using std::list.

Definition at line 109 of file vector.tcc.

References std::begin(), and std::end().

Referenced by std::vector< _State >::resize().

iterator std::vector::insert ( iterator  __position,
value_type &&  __x 
) [inline]

Inserts given rvalue into vector before specified iterator.

Parameters:
positionAn iterator into the vector.
xData 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. Note that this kind of operation could be expensive for a vector and if it is frequently used the user should consider using std::list.

Definition at line 908 of file stl_vector.h.

void std::vector::insert ( iterator  __position,
initializer_list< value_type >  __l 
) [inline]

Inserts an initializer_list into the vector.

Parameters:
positionAn iterator into the vector.
lAn initializer_list.

This function will insert copies of the data in the initializer_list l into the vector before the location specified by position.

Note that this kind of operation could be expensive for a vector and if it is frequently used the user should consider using std::list.

Definition at line 925 of file stl_vector.h.

Referenced by std::vector< _State >::insert().

void std::vector::insert ( iterator  __position,
size_type  __n,
const value_type &  __x 
) [inline]

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

Parameters:
positionAn iterator into the vector.
nNumber of elements to be inserted.
xData to be inserted.

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

Note that this kind of operation could be expensive for a vector and if it is frequently used the user should consider using std::list.

Definition at line 943 of file stl_vector.h.

template<typename _InputIterator >
void std::vector::insert ( iterator  __position,
_InputIterator  __first,
_InputIterator  __last 
) [inline]

Inserts a range into the vector.

Parameters:
positionAn iterator into the vector.
firstAn input iterator.
lastAn input iterator.

This function will insert copies of the data in the range [first,last) into the vector before the location specified by pos.

Note that this kind of operation could be expensive for a vector and if it is frequently used the user should consider using std::list.

Definition at line 962 of file stl_vector.h.

size_type std::vector::max_size ( ) const [inline]

Returns the size() of the largest possible vector.

Reimplemented in std::match_results.

Definition at line 575 of file stl_vector.h.

vector& std::vector::operator= ( const vector __x)

Vector assignment operator.

Parameters:
xA vector of identical element and allocator types.

All the elements of x are copied, but any extra memory in x (for fast expansion) will not be copied. Unlike the copy constructor, the allocator object is not copied.

vector& std::vector::operator= ( vector &&  __x) [inline]

Vector move assignment operator.

Parameters:
xA vector of identical element and allocator types.

The contents of x are moved into this vector (without copying). x is a valid, but unspecified vector.

Definition at line 373 of file stl_vector.h.

vector& std::vector::operator= ( initializer_list< value_type >  __l) [inline]

Vector list assignment operator.

Parameters:
lAn initializer_list.

This function fills a vector with copies of the elements in the initializer list l.

Note that the assignment completely changes the vector and that the resulting vector's size is the same as the number of elements assigned. Old data may be lost.

Definition at line 394 of file stl_vector.h.

reference std::vector::operator[] ( size_type  __n) [inline]

Subscript access to the data contained in the vector.

Parameters:
nThe 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 695 of file stl_vector.h.

const_reference std::vector::operator[] ( size_type  __n) const [inline]

Subscript access to the data contained in the vector.

Parameters:
nThe 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 710 of file stl_vector.h.

void std::vector::pop_back ( ) [inline]

Removes last element.

This is a typical stack operation. It shrinks the vector 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 857 of file stl_vector.h.

void std::vector::push_back ( const value_type &  __x) [inline]

Add data to the end of the vector.

Parameters:
xData to be added.

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

Definition at line 826 of file stl_vector.h.

Referenced by __gnu_parallel::multiseq_partition(), and __gnu_parallel::multiseq_selection().

reverse_iterator std::vector::rbegin ( ) [inline]

Returns a read/write reverse iterator that points to the last element in the vector. Iteration is done in reverse element order.

Definition at line 499 of file stl_vector.h.

const_reverse_iterator std::vector::rbegin ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to the last element in the vector. Iteration is done in reverse element order.

Definition at line 508 of file stl_vector.h.

reverse_iterator std::vector::rend ( ) [inline]

Returns a read/write reverse iterator that points to one before the first element in the vector. Iteration is done in reverse element order.

Definition at line 517 of file stl_vector.h.

const_reverse_iterator std::vector::rend ( ) const [inline]

Returns a read-only (constant) reverse iterator that points to one before the first element in the vector. Iteration is done in reverse element order.

Definition at line 526 of file stl_vector.h.

void vector::reserve ( size_type  __n)

Attempt to preallocate enough memory for specified number of elements.

Parameters:
nNumber of elements required.
Exceptions:
std::length_errorIf n exceeds max_size().

This function attempts to reserve enough memory for the vector to hold the specified number of elements. If the number requested is more than max_size(), length_error is thrown.

The advantage of this function is that if optimal code is a necessity and the user can determine the number of elements that will be required, the user can reserve the memory in advance, and thus prevent a possible reallocation of memory and copying of vector data.

Definition at line 67 of file vector.tcc.

References std::size(), and std::_Destroy().

void std::vector::resize ( size_type  __new_size) [inline]

Resizes the vector to the specified number of elements.

Parameters:
new_sizeNumber of elements the vector should contain.

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

Definition at line 589 of file stl_vector.h.

Referenced by __gnu_parallel::__shrink_and_double(), __gnu_parallel::multiway_merge_exact_splitting(), and __gnu_parallel::parallel_sort_mwms().

void std::vector::resize ( size_type  __new_size,
const value_type &  __x 
) [inline]

Resizes the vector to the specified number of elements.

Parameters:
new_sizeNumber of elements the vector should contain.
xData with which new elements should be populated.

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

Definition at line 609 of file stl_vector.h.

void std::vector::shrink_to_fit ( ) [inline]

A non-binding request to reduce capacity() to size().

Definition at line 641 of file stl_vector.h.

size_type std::vector::size ( ) const [inline]
void std::vector::swap ( vector __x) [inline]

Swaps data with another vector.

Parameters:
xA vector of the same element and allocator types.

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

Definition at line 1019 of file stl_vector.h.

Referenced by std::vector< _State >::operator=(), and std::vector< _State >::swap().


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