std::forward_list

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Containers library

array (C++11)

vector

deque

forward_list (C++11)

list

set

multiset

map

multimap

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

stack

queue

priority_queue

span (C++20)

 

std::forward_list

Member functions

forward_list::forward_list

forward_list::~forward_list

forward_list::operator=

forward_list::assign

forward_list::get_allocator

Element access

forward_list::front

Iterators

forward_list::before_beginforward_list::cbefore_begin

forward_list::beginforward_list::cbegin

forward_list::endforward_list::cend

Capacity

forward_list::empty

forward_list::max_size

Modifiers

forward_list::clear

forward_list::insert_after

forward_list::emplace_after

forward_list::erase_after

forward_list::push_front

forward_list::emplace_front

forward_list::pop_front

forward_list::resize

forward_list::swap

Operations

forward_list::merge

forward_list::splice_after

forward_list::removeforward_list::remove_if

forward_list::reverse

forward_list::unique

forward_list::sort

Deduction guides(C++17)

 

Defined in header <forward_list>
template<     class T,     class Allocator = std::allocator<T> > class forward_list;	(1)	(since C++11)
namespace pmr {     template <class T>     using forward_list = std::forward_list<T, std::pmr::polymorphic_allocator<T>>; }	(2)	(since C++17)

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.

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 Erasable, but many member functions impose stricter requirements. (until C++17) The requirements that are imposed on the elements depend on the actual operations performed on the container. Generally, it is required that element type meets the requirements of Erasable, but many member functions impose stricter requirements. This container (but not its members) can be instantiated with an incomplete element type if the allocator satisfies the allocator completeness requirements. (since C++17)
Allocator	-	An allocator that is used to acquire/release memory and to construct/destroy the elements in that memory. The type must meet the requirements of Allocator. The behavior is undefined if Allocator::value_type is not the same as T.

Member types

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

Member functions

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

Non-member functions

operator==operator!=operator<operator<=operator>operator>=	lexicographically compares the values in the forward_list (function template)
std::swap(std::forward_list) (C++11)	specializes the std::swap algorithm (function template)
erase(std::forward_list)erase_if(std::forward_list) (C++20)	Erases all elements satisfying specific criteria (function template)