std::list

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators 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

 

std::list

Member functions

list::list

list::~list

list::operator=

list::assign

list::get_allocator

Element access

list::front

list::back

Iterators

list::beginlist::cbegin (C++11)

list::endlist::cend (C++11)

list::rbeginlist::crbegin (C++11)

list::rendlist::crend (C++11)

Capacity

list::empty

list::size

list::max_size

Modifiers

list::clear

list::insert

list::emplace (C++11)

list::erase

list::push_front

list::emplace_front (C++11)

list::pop_front

list::push_back

list::emplace_back (C++11)

list::pop_back

list::resize

list::swap

Operations

list::merge

list::splice

list::removelist::remove_if

list::reverse

list::unique

list::sort

 

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

std::list is a container that supports constant time insertion and removal of elements from anywhere in the container. Fast random access is not supported. It is usually implemented as a doubly-linked list. Compared to std::forward_list this container provides bidirectional iteration capability while being less space efficient.

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

std::list meets the requirements of Container, AllocatorAwareContainer, SequenceContainer and ReversibleContainer.

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 Erasable, but many member functions impose stricter requirements. (since C++11) (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 memory to store the elements. 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 integral type (usually std::size_t)
difference_type	Signed integer type (usually std::ptrdiff_t)
reference	Allocator::reference (until C++11) value_type& (since C++11)
const_reference	Allocator::const_reference (until C++11) const value_type& (since C++11)
pointer	Allocator::pointer (until C++11) std::allocator_traits<Allocator>::pointer (since C++11)
const_pointer	Allocator::const_pointer (until C++11) std::allocator_traits<Allocator>::const_pointer (since C++11)
iterator	BidirectionalIterator
const_iterator	Constant bidirectional iterator
reverse_iterator	std::reverse_iterator<iterator>
const_reverse_iterator	std::reverse_iterator<const_iterator>

Member functions

(constructor)	constructs the list (public member function)
(destructor)	destructs the 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)
back	access the last element (public member function)
Iterators
begin cbegin	returns an iterator to the beginning (public member function)
end cend	returns an iterator to the end (public member function)
rbegin crbegin	returns a reverse iterator to the beginning (public member function)
rend crend	returns a reverse iterator to the end (public member function)
Capacity
empty	checks whether the container is empty (public member function)
size	returns the number of elements (public member function)
max_size	returns the maximum possible number of elements (public member function)
Modifiers
clear	clears the contents (public member function)
insert	inserts elements (public member function)
emplace (C++11)	constructs element in-place (public member function)
erase	erases elements (public member function)
push_back	adds an element to the end (public member function)
emplace_back (C++11)	constructs an element in-place at the end (public member function)
pop_back	removes the last element (public member function)
push_front	inserts an element to the beginning (public member function)
emplace_front (C++11)	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	moves elements from another 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 list (function template)
std::swap(std::list)	specializes the std::swap algorithm (function template)