std::list - cppreference.com (original) (raw)

Defined in header
template< class T, class Allocator = std::allocator<T> > class list; (1)
namespace pmr { template< class T > using list = std::list<T, std::pmr::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.

Adding, removing 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.

All member functions of std::list are constexpr: it is possible to create and use std::list objects in the evaluation of a constant expression.However, std::list objects generally cannot be constexpr, because any dynamically allocated storage must be released in the same evaluation of constant expression. (since C++26)

Contents

[edit] Template parameters

T - The type of the elements. T must meet the requirements of CopyConstructible. T must meet the requirements of CopyAssignable if list::operator= or list::assign is instantiated with T. (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. Feature-test macro Value Std Feature __cpp_lib_incomplete_container_elements 201505L (C++17) Minimal incomplete type support (since C++17) [edit]
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(until C++20)The program is ill-formed(since C++20) if Allocator::value_type is not the same as T.[edit]

[edit] Member types

[edit] Member functions

(constructor) constructs the list (public member function) [edit]
(destructor) destructs the 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]
assign_range(C++23) assigns a range of 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]
back access the last element (public member function) [edit]
Iterators
begincbegin(C++11) returns an iterator to the beginning (public member function) [edit]
endcend(C++11) returns an iterator to the end (public member function) [edit]
rbegincrbegin(C++11) returns a reverse iterator to the beginning (public member function) [edit]
rendcrend(C++11) returns a reverse iterator to the end (public member function) [edit]
Capacity
empty checks whether the container is empty (public member function) [edit]
size returns the number of elements (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 inserts elements (public member function) [edit]
insert_range(C++23) inserts a range of elements (public member function) [edit]
emplace(C++11) constructs element in-place (public member function) [edit]
erase erases elements (public member function) [edit]
push_back adds an element to the end (public member function) [edit]
emplace_back(C++11) constructs an element in-place at the end (public member function) [edit]
append_range(C++23) adds a range of elements to the end (public member function) [edit]
pop_back removes the last element (public member function) [edit]
push_front inserts an element to the beginning (public member function) [edit]
emplace_front(C++11) constructs an element in-place at the beginning (public member function) [edit]
prepend_range(C++23) adds a range of elements to 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 transfers elements from another 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

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_containers_ranges 202202L (C++23) Ranges construction and insertion for containers
__cpp_lib_constexpr_list 202502L (C++26) constexpr std::list

[edit] Example

#include #include #include   int main() { // Create a list containing integers std::list l = {7, 5, 16, 8};   // Add an integer to the front of the list l.push_front(25); // Add an integer to the back of the list l.push_back(13);   // Insert an integer before 16 by searching auto it = std::find(l.begin(), l.end(), 16); if (it != l.end()) l.insert(it, 42);   // Print out the list std::cout << "l = { "; for (int n : l) std::cout << n << ", "; std::cout << "};\n"; }

Output:

l = { 25, 7, 5, 42, 16, 8, 13, };

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 230 C++98 T was not required to be CopyConstructible(an element of type T might not be able to be constructed) T is also required tobe CopyConstructible
LWG 276 C++98 T was always required to be CopyAssignable only required if operator= orassign is instantiated with T

[edit] See also