Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/container/list"

From cppreference.com
< cpp‎ | container
(add template params)
m (→‎See also: +)
 
(41 intermediate revisions by 23 users not shown)
Line 1: Line 1:
 
{{cpp/title|list}}
 
{{cpp/title|list}}
 
{{cpp/container/list/navbar}}
 
{{cpp/container/list/navbar}}
−
{{ddcl | header=list |
+
{{dcl begin}}
 +
{{dcl header|list}}
 +
{{dcl|num=1|1=
 
template<
 
template<
 
     class T,
 
     class T,
−
     class Allocator {{=}} std::allocator<T>
+
     class Allocator = std::allocator<T>
 
> class list;
 
> class list;
−
}}  
+
}}
 +
{{dcl|num=2|since=c++17|1=
 +
namespace pmr {
 +
    template< class T >
 +
    using list = std::list<T, std::pmr::polymorphic_allocator<T>>;
 +
}
 +
}}
 +
{{dcl end}}
  
−
{{tt|std::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 usually implemented as double-linked list. Compared to {{c|std::forward_list}} this container provides bidirectional iteration capability while being less space efficient.
+
{{tt|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 {{lc|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. An iterator is invalidated only when the corresponding element is deleted.
+
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.
  
−
{{tt|std::list}} meets the requirements of {{concept|Container}}, {{concept|AllocatorAwareContainer}}, {{concept|SequenceContainer}} and {{concept|ReversibleContainer}}.
+
{{tt|std::list}} meets the requirements of {{named req|Container}}, {{named req|AllocatorAwareContainer}}, {{named req|SequenceContainer}} and {{named req|ReversibleContainer}}.
  
−
====Template parameters====
+
===Template parameters===
−
{{param list begin}}
+
{{par begin}}
−
{{param list template | cpp/container/param list T | deque}}
+
{{par inc|cpp/container/param list T|list}}
−
{{param list template | cpp/container/param list Allocator | deque}}
+
{{par inc|cpp/container/param list Allocator|list}}
−
{{param list end}}
+
{{par end}}
  
 
===Member types===
 
===Member types===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list hitem | Member type | Definition}}
+
{{dsc hitem|Member type|Definition}}
−
{{dcl list template | cpp/container/dcl list value_type | list}}
+
{{dsc inc|cpp/container/dsc value_type|list}}
−
{{dcl list template | cpp/container/dcl list allocator_type | list}}
+
{{dsc inc|cpp/container/dsc allocator_type|list}}
−
{{dcl list template | cpp/container/dcl list size_type | list}}
+
{{dsc inc|cpp/container/dsc size_type|list}}
−
{{dcl list template | cpp/container/dcl list difference_type | list}}
+
{{dsc inc|cpp/container/dsc difference_type|list}}
−
{{dcl list template | cpp/container/dcl list reference | list}}
+
{{dsc inc|cpp/container/dsc reference|list}}
−
{{dcl list template | cpp/container/dcl list const_reference | list}}
+
{{dsc inc|cpp/container/dsc const_reference|list}}
−
{{dcl list template | cpp/container/dcl list pointer | list}}
+
{{dsc inc|cpp/container/dsc pointer|list}}
−
{{dcl list template | cpp/container/dcl list const_pointer | list}}
+
{{dsc inc|cpp/container/dsc const_pointer|list}}
−
{{dcl list template | cpp/container/dcl list iterator | list}}
+
{{dsc inc|cpp/container/dsc iterator|list}}
−
{{dcl list template | cpp/container/dcl list const_iterator | list}}
+
{{dsc inc|cpp/container/dsc const_iterator|list}}
−
{{dcl list template | cpp/container/dcl list reverse_iterator | list}}
+
{{dsc inc|cpp/container/dsc reverse_iterator|list}}
−
{{dcl list template | cpp/container/dcl list const_reverse_iterator | list}}
+
{{dsc inc|cpp/container/dsc const_reverse_iterator|list}}
−
{{dcl list end}}
+
{{dsc end}}
  
 
===Member functions===
 
===Member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/container/dcl list constructor | list}}
+
{{dsc inc|cpp/container/dsc constructor|list}}
−
{{dcl list template | cpp/container/dcl list destructor | list}}
+
{{dsc inc|cpp/container/dsc destructor|list}}
−
{{dcl list template | cpp/container/dcl list operator{{=}} | list}}
+
{{dsc inc|cpp/container/dsc operator{{=}}|list}}
−
{{dcl list template | cpp/container/dcl list assign | list}}
+
{{dsc inc|cpp/container/dsc assign|list}}
−
{{dcl list template | cpp/container/dcl list get_allocator | list}}
+
{{dsc inc|cpp/container/dsc assign_range|list}}
 +
{{dsc inc|cpp/container/dsc get_allocator|list}}
  
−
{{dcl list h2 | Element access}}
+
{{dsc h2|Element access}}
−
{{dcl list template | cpp/container/dcl list front | list}}
+
{{dsc inc|cpp/container/dsc front|list}}
−
{{dcl list template | cpp/container/dcl list back | list}}
+
{{dsc inc|cpp/container/dsc back|list}}
  
−
{{dcl list h2 | Iterators}}
+
{{dsc h2|Iterators}}
−
{{dcl list template | cpp/container/dcl list begin | list}}
+
{{dsc inc|cpp/container/dsc begin|list}}
−
{{dcl list template | cpp/container/dcl list end | list}}
+
{{dsc inc|cpp/container/dsc end|list}}
−
{{dcl list template | cpp/container/dcl list rbegin | list}}
+
{{dsc inc|cpp/container/dsc rbegin|list}}
−
{{dcl list template | cpp/container/dcl list rend | list}}
+
{{dsc inc|cpp/container/dsc rend|list}}
  
−
{{dcl list h2 | Capacity}}
+
{{dsc h2|Capacity}}
−
{{dcl list template | cpp/container/dcl list empty | list}}
+
{{dsc inc|cpp/container/dsc empty|list}}
−
{{dcl list template | cpp/container/dcl list size | list}}
+
{{dsc inc|cpp/container/dsc size|list}}
−
{{dcl list template | cpp/container/dcl list max_size | list}}
+
{{dsc inc|cpp/container/dsc max_size|list}}
  
−
{{dcl list h2 | Modifiers}}
+
{{dsc h2|Modifiers}}
−
{{dcl list template | cpp/container/dcl list clear | list}}
+
{{dsc inc|cpp/container/dsc clear|list}}
−
{{dcl list template | cpp/container/dcl list insert | list}}
+
{{dsc inc|cpp/container/dsc insert|list}}
−
{{dcl list template | cpp/container/dcl list emplace | list}}
+
{{dsc inc|cpp/container/dsc insert_range|list}}
−
{{dcl list template | cpp/container/dcl list erase | list}}
+
{{dsc inc|cpp/container/dsc emplace|list}}
−
{{dcl list template | cpp/container/dcl list push_back | list}}
+
{{dsc inc|cpp/container/dsc erase|list}}
−
{{dcl list template | cpp/container/dcl list emplace_back | list}}
+
{{dsc inc|cpp/container/dsc push_back|list}}
−
{{dcl list template | cpp/container/dcl list pop_back | list}}
+
{{dsc inc|cpp/container/dsc emplace_back|list}}
−
{{dcl list template | cpp/container/dcl list push_front | list}}
+
{{dsc inc|cpp/container/dsc append_range|list}}
−
{{dcl list template | cpp/container/dcl list emplace_front | list}}
+
{{dsc inc|cpp/container/dsc pop_back|list}}
−
{{dcl list template | cpp/container/dcl list pop_front | list}}
+
{{dsc inc|cpp/container/dsc push_front|list}}
−
{{dcl list template | cpp/container/dcl list resize | list}}
+
{{dsc inc|cpp/container/dsc emplace_front|list}}
−
{{dcl list template | cpp/container/dcl list swap | list}}
+
{{dsc inc|cpp/container/dsc prepend_range|list}}
 +
{{dsc inc|cpp/container/dsc pop_front|list}}
 +
{{dsc inc|cpp/container/dsc resize|list}}
 +
{{dsc inc|cpp/container/dsc swap|list}}
  
−
{{dcl list h2 | Operations}}
+
{{dsc h2|Operations}}
−
{{dcl list template | cpp/container/dcl list merge | list}}
+
{{dsc inc|cpp/container/dsc merge|list}}
−
{{dcl list template | cpp/container/dcl list splice | list}}
+
{{dsc inc|cpp/container/dsc splice|list}}
−
{{dcl list template | cpp/container/dcl list remove | list}}
+
{{dsc inc|cpp/container/dsc remove|list}}
−
{{dcl list template | cpp/container/dcl list reverse | list}}
+
{{dsc inc|cpp/container/dsc reverse|list}}
−
{{dcl list template | cpp/container/dcl list unique | list}}
+
{{dsc inc|cpp/container/dsc unique|list}}
−
{{dcl list template | cpp/container/dcl list sort | list}}
+
{{dsc inc|cpp/container/dsc sort|list}}
−
{{dcl list end}}
+
{{dsc end}}
  
 
===Non-member functions===
 
===Non-member functions===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/container/dcl list operator_cmp | list}}
+
{{dsc inc|cpp/container/dsc operator_cmp|list}}
−
{{dcl list template | cpp/container/dcl list swap2 | list}}
+
{{dsc inc|cpp/container/dsc swap2|list}}
−
{{dcl list end}}
+
{{dsc inc|cpp/container/dsc erase seq|list}}
 +
{{dsc end}}
  
−
[[de:cpp/container/list]]
+
{{rrev|since=c++17|
−
[[es:cpp/container/list]]
+
==={{rl|deduction guides|Deduction guides}}===
−
[[fr:cpp/container/list]]
+
}}
−
[[it:cpp/container/list]]
+
 
−
[[ja:cpp/container/list]]
+
===Notes===
−
[[pt:cpp/container/list]]
+
{{ftm begin|std=1|comment=1}}
−
[[ru:cpp/container/list]]
+
{{ftm|__cpp_lib_containers_ranges|value=202202L|std=C++23|Ranges construction and insertion for containers}}
−
[[zh:cpp/container/list]]
+
{{ftm end}}
 +
 
 +
===Example===
 +
{{example
 +
|code=
 +
#include <algorithm>
 +
#include <iostream>
 +
#include <list>
 +
 
 +
int main()
 +
{
 +
    // Create a list containing integers
 +
    std::list<int> 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, };
 +
}}
 +
 
 +
===Defect reports===
 +
{{dr list begin}}
 +
{{dr list item|wg=lwg|dr=230|std=C++98|before={{tt|T}} was not required to be {{named req|CopyConstructible}}<br>(an element of type {{tt|T}} might not be able to be constructed)|after={{tt|T}} is also required to<br>be {{named req|CopyConstructible}}}}
 +
{{dr list item|wg=lwg|dr=276|std=C++98|before={{tt|T}} was always required to be {{named req|CopyAssignable}}|after=only required if {{ltt|cpp/container/list/operator{{=}}}} or<br>{{ltt|cpp/container/list/assign}} is instantiated with {{tt|T}}}}
 +
{{dr list end}}
 +
 
 +
===See also===
 +
{{dsc begin}}
 +
{{dsc inc|cpp/container/dsc forward_list}}
 +
{{dsc end}}
 +
 
 +
{{langlinks|de|es|fr|it|ja|ko|pl|pt|ru|zh}}

Latest revision as of 20:56, 2 August 2024

 
C++
 
Containers library
 
std::list
Member functions
Non-member functions
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)
Deduction guides(C++17)
 
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::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.

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

Member type Definition
value_type T[edit]
allocator_type Allocator[edit]
size_type Unsigned integer 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

Allocator::pointer

(until C++11)

std::allocator_traits<Allocator>::pointer

(since C++11)
[edit]
const_pointer

Allocator::const_pointer

(until C++11)

std::allocator_traits<Allocator>::const_pointer

(since C++11)
[edit]
iterator LegacyBidirectionalIterator to value_type[edit]
const_iterator LegacyBidirectionalIterator to const value_type[edit]
reverse_iterator std::reverse_iterator<iterator>[edit]
const_reverse_iterator std::reverse_iterator<const_iterator>[edit]

[edit] Member functions

 constructs the list
(public member function) [edit]
destructs the list
(public member function) [edit]
assigns values to the container
(public member function) [edit]
assigns values to the container
(public member function) [edit]
(C++23)
 assigns a range of 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]
access the last element
(public member function) [edit]
Iterators
(C++11)
 returns an iterator to the beginning
(public member function) [edit]
(C++11)
 returns an iterator to the end
(public member function) [edit]
(C++11)
 returns a reverse iterator to the beginning
(public member function) [edit]
(C++11)
 returns a reverse iterator to the end
(public member function) [edit]
Capacity
checks whether the container is empty
(public member function) [edit]
returns the number of elements
(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
(public member function) [edit]
(C++23)
 inserts a range of elements
(public member function) [edit]
(C++11)
 constructs element in-place
(public member function) [edit]
erases elements
(public member function) [edit]
adds an element to the end
(public member function) [edit]
(C++11)
 constructs an element in-place at the end
(public member function) [edit]
(C++23)
 adds a range of elements to the end
(public member function) [edit]
removes the last element
(public member function) [edit]
inserts an element to the beginning
(public member function) [edit]
(C++11)
 constructs an element in-place at the beginning
(public member function) [edit]
(C++23)
 adds a range of elements to 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 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]

[edit] Non-member functions

(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(C++20)
 lexicographically compares the values of two lists
(function template) [edit]
specializes the std::swap algorithm
(function template) [edit]
(C++20)
 erases all elements satisfying specific criteria
(function template) [edit]

Deduction guides

 (since C++17)

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_containers_ranges 202202L (C++23) Ranges construction and insertion for containers

[edit] Example

Run this code
#include <algorithm>
#include <iostream>
#include <list>
 
int main()
{
    // Create a list containing integers
    std::list<int> 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 to
be CopyConstructible
LWG 276 C++98 T was always required to be CopyAssignable only required if operator= or
assign is instantiated with T

[edit] See also

(C++11)
 singly-linked list
(class template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/container/list&oldid=174036"