std::forward_list - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# std::forward_list

From cppreference.com
< cpp‎ | container

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

Adding, removing and moving the elements within the list, or across several lists, does not invalidate the iterators currently referring to other elements in the list. However, an iterator or reference referring to an element is invalidated when the corresponding element is removed (via erase_after) from the list.

`std::forward_list` meets the requirements of `Container` (except for the size member function and that `operator==`'s complexity is always linear), `AllocatorAwareContainer` and `SequenceContainer`.

### [edit] Template parameters

T | - | The type of the elements. 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.
Allocator | - | An allocator that is used to acquire memory to store the elements. The type must meet the requirements of `Allocator`. [edit]

### [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]

### [edit] Member functions

(constructor) | constructs the `forward_list` (public member function) [edit]
(destructor) | destructs the `forward_list` (public member function) [edit]
operator= | assigns values to the container (public member function) [edit]
assign | assigns values to the container (public member function) [edit]
get_allocator | returns the associated allocator (public member function) [edit]
##### Element access
front | access the first element (public member function) [edit]
##### Iterators
before_begin cbefore_begin | returns an iterator to the element before beginning (public member function) [edit]
begin cbegin | returns an iterator to the beginning (public member function) [edit]
end cend | returns an iterator to the end (public member function) [edit]
##### Capacity
empty | checks whether the container is empty (public member function) [edit]
max_size | returns the maximum possible number of elements (public member function) [edit]
##### Modifiers
clear | clears the contents (public member function) [edit]
insert_after | inserts elements after an element (public member function) [edit]
emplace_after | constructs elements in-place after an element (public member function) [edit]
erase_after | erases an element after an element (public member function) [edit]
push_front | inserts elements to the beginning (public member function) [edit]
emplace_front | constructs elements in-place at the beginning (public member function) [edit]
pop_front | removes the first element (public member function) [edit]
resize | changes the number of elements stored (public member function) [edit]
swap | swaps the contents (public member function) [edit]
##### Operations
merge | merges two sorted lists (public member function) [edit]
splice_after | moves elements from another `forward_list` (public member function) [edit]
removeremove_if | removes elements satisfying specific criteria (public member function) [edit]
reverse | reverses the order of the elements (public member function) [edit]
unique | removes consecutive duplicate elements (public member function) [edit]
sort | sorts the elements (public member function) [edit]

### [edit] Non-member functions

operator==operator!=operator<operator<=operator>operator>= | lexicographically compares the values in the forward_list (function template) [edit]
std::swap(std::forward_list) (C++11) | specializes the std::swap algorithm (function template) [edit]

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/container/forward_list&oldid=70687"