Namespaces
Variants
Views
Actions

std::forward_list

From cppreference.com
< cpp‎ | container
Revision as of 22:50, 31 May 2013 by P12bot (Talk | contribs)

Defined in header <forward_list>
template<

    class T,
    class Allocator = std::allocator<T>

> class forward_list;
(since C++11)

std::forward_list is a container that supports fast insertion and removal of elements from anywhere in the container. Fast random access is not supported. It is implemented as singly-linked list and essentially does not have any overhead compared to its implementation in C. Compared to std::list this container provides more space efficient storage when bidirectional iteration is not needed.

Addition, removal and moving the elements within the list or across several lists does not invalidate the iterators. An iterator is invalidated only when the corresponding element is deleted.

std::forward_list meets the requirements of Container (except for the size() member function), AllocatorAwareContainer and SequenceContainer.

Contents

Template parameters

T - The type of the elements.
T must meet the requirements of CopyAssignable and CopyConstructible. (until C++11)
The requirements that are imposed on the elements depend on the actual operations performed on the container. Generally, it is required that element type is a complete type and meets the requirements of MoveConstructible and MoveAssignable, but many member functions impose stricter requirements. (since C++11)

[edit]

Allocator - An allocator that is used to acquire memory to store the elements. The type must meet the requirements of Allocator. [edit]

Member types

Member type Definition
value_type T [edit]
allocator_type Allocator [edit]
size_type Unsigned integral type (usually std::size_t) [edit]
difference_type Signed integer type (usually std::ptrdiff_t) [edit]
reference value_type& [edit]
const_reference const value_type& [edit]
pointer std::allocator_traits<Allocator>::pointer [edit]
const_pointer std::allocator_traits<Allocator>::const_pointer [edit]
iterator ForwardIterator [edit]
const_iterator Constant forward iterator [edit]

Member functions

constructs the forward_list
(public member function) [edit]
destructs the forward_list
(public member function) [edit]
assigns values to the container
(public member function) [edit]
assigns values to the container
(public member function) [edit]
returns the associated allocator
(public member function) [edit]
Element access
access the first element
(public member function) [edit]
Iterators
returns an iterator to the element before beginning
(public member function) [edit]
returns an iterator to the beginning
(public member function) [edit]
returns an iterator to the end
(public member function) [edit]
Capacity
checks whether the container is empty
(public member function) [edit]
returns the maximum possible number of elements
(public member function) [edit]
Modifiers
clears the contents
(public member function) [edit]
inserts elements after an element
(public member function) [edit]
constructs elements in-place after an element
(public member function) [edit]
erases an element after an element
(public member function) [edit]
inserts elements to the beginning
(public member function) [edit]
constructs elements in-place at the beginning
(public member function) [edit]
removes the first element
(public member function) [edit]
changes the number of elements stored
(public member function) [edit]
swaps the contents
(public member function) [edit]
Operations
merges two sorted lists
(public member function) [edit]
moves elements from another forward_list
(public member function) [edit]
removes elements satisfying specific criteria
(public member function) [edit]
reverses the order of the elements
(public member function) [edit]
removes consecutive duplicate elements
(public member function) [edit]
sorts the elements
(public member function) [edit]

Non-member functions

lexicographically compares the values in the forward_list
(function template) [edit]
specializes the std::swap algorithm
(function template) [edit]