Meets the requirements of a container, a reversible container, and a sequence, including the optional sequence requirements with the exception of at
and operator
[].
This is a doubly linked list. Traversal up and down the list requires linear time, but adding and removing elements (or nodes) is done in constant time, regardless of where the change takes place. Unlike std::vector and std::deque, random-access iterators are not provided, so subscripting ( [] ) access is not allowed. For algorithms which only need sequential access, this lack makes no difference.
Also unlike the other standard containers, std::list provides specialized algorithms unique to linked lists, such as splicing, sorting, and in-place reversal.
A couple points on memory allocation for list<Tp>:
First, we never actually allocate a Tp, we allocate List_node<Tp>'s and trust [20.1.5]/4 to DTRT. This is to ensure that after elements from list<X,Alloc1> are spliced into list<X,Alloc2>, destroying the memory of the second list is a valid operation, i.e., Alloc1 giveth and Alloc2 taketh away.
Second, a list conceptually represented as
A <---> B <---> C <---> D
Definition at line 417 of file stl_list.h.
std::list< _Tp, _Alloc >::list | ( | const allocator_type & | __a | ) | [inline, explicit] |
Creates a list with no elements.
a | An allocator object. |
Definition at line 507 of file stl_list.h.
std::list< _Tp, _Alloc >::list | ( | size_type | __n, | |
const value_type & | __value = value_type() , |
|||
const allocator_type & | __a = allocator_type() | |||
) | [inline, explicit] |
Creates a list with copies of an exemplar element.
n | The number of elements to initially create. | |
value | An element to copy. | |
a | An allocator object. |
Definition at line 519 of file stl_list.h.
std::list< _Tp, _Alloc >::list | ( | const list< _Tp, _Alloc > & | __x | ) | [inline] |
List copy constructor.
x | A list of identical element and allocator types. |
Definition at line 531 of file stl_list.h.
References std::list< _Tp, _Alloc >::begin(), and std::list< _Tp, _Alloc >::end().
std::list< _Tp, _Alloc >::list | ( | list< _Tp, _Alloc > && | __x | ) | [inline] |
List move constructor.
x | A list of identical element and allocator types. |
Definition at line 543 of file stl_list.h.
std::list< _Tp, _Alloc >::list | ( | initializer_list< value_type > | __l, | |
const allocator_type & | __a = allocator_type() | |||
) | [inline] |
Builds a list from an initializer_list.
l | An initializer_list of value_type. | |
a | An allocator object. |
Definition at line 554 of file stl_list.h.
References std::initializer_list< _E >::begin(), and std::initializer_list< _E >::end().
std::list< _Tp, _Alloc >::list | ( | _InputIterator | __first, | |
_InputIterator | __last, | |||
const allocator_type & | __a = allocator_type() | |||
) | [inline] |
Builds a list from a range.
Create a list consisting of copies of the elements from [first,last). This is linear in N (where N is distance(first,last)).
Definition at line 571 of file stl_list.h.
_Node* std::list< _Tp, _Alloc >::_M_create_node | ( | _Args &&... | __args | ) | [inline, protected] |
x | An instance of user data. |
Definition at line 476 of file stl_list.h.
Referenced by std::list< _Tp, _Alloc >::emplace(), and std::list< _Tp, _Alloc >::insert().
void std::list< _Tp, _Alloc >::assign | ( | initializer_list< value_type > | __l | ) | [inline] |
Assigns an initializer_list to a list.
l | An initializer_list of value_type. |
Definition at line 674 of file stl_list.h.
References std::list< _Tp, _Alloc >::assign(), std::initializer_list< _E >::begin(), and std::initializer_list< _E >::end().
Referenced by std::list< _Tp, _Alloc >::assign().
void std::list< _Tp, _Alloc >::assign | ( | _InputIterator | __first, | |
_InputIterator | __last | |||
) | [inline] |
Assigns a range to a list.
This function fills a list with copies of the elements in the range [first,last).
Note that the assignment completely changes the list and that the resulting list's size is the same as the number of elements assigned. Old data may be lost.
Definition at line 658 of file stl_list.h.
void std::list< _Tp, _Alloc >::assign | ( | size_type | __n, | |
const value_type & | __val | |||
) | [inline] |
Assigns a given value to a list.
n | Number of elements to be assigned. | |
val | Value to be assigned. |
Definition at line 641 of file stl_list.h.
const_reference std::list< _Tp, _Alloc >::back | ( | ) | const [inline] |
Returns a read-only (constant) reference to the data at the last element of the list.
Definition at line 859 of file stl_list.h.
reference std::list< _Tp, _Alloc >::back | ( | ) | [inline] |
Returns a read/write reference to the data at the last element of the list.
Definition at line 847 of file stl_list.h.
const_iterator std::list< _Tp, _Alloc >::begin | ( | ) | const [inline] |
Returns a read-only (constant) iterator that points to the first element in the list. Iteration is done in ordinary element order.
Definition at line 698 of file stl_list.h.
iterator std::list< _Tp, _Alloc >::begin | ( | ) | [inline] |
Returns a read/write iterator that points to the first element in the list. Iteration is done in ordinary element order.
Definition at line 689 of file stl_list.h.
Referenced by std::list< _Tp, _Alloc >::list(), std::list< _Tp, _Alloc >::merge(), std::list< _Tp, _Alloc >::operator=(), std::operator==(), std::list< _Tp, _Alloc >::remove(), std::list< _Tp, _Alloc >::remove_if(), std::list< _Tp, _Alloc >::resize(), std::list< _Tp, _Alloc >::sort(), std::list< _Tp, _Alloc >::splice(), and std::list< _Tp, _Alloc >::unique().
const_iterator std::list< _Tp, _Alloc >::cbegin | ( | ) | const [inline] |
Returns a read-only (constant) iterator that points to the first element in the list. Iteration is done in ordinary element order.
Definition at line 762 of file stl_list.h.
const_iterator std::list< _Tp, _Alloc >::cend | ( | ) | const [inline] |
Returns a read-only (constant) iterator that points one past the last element in the list. Iteration is done in ordinary element order.
Definition at line 771 of file stl_list.h.
void std::list< _Tp, _Alloc >::clear | ( | ) | [inline] |
Erases all the elements. Note that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 1130 of file stl_list.h.
const_reverse_iterator std::list< _Tp, _Alloc >::crbegin | ( | ) | const [inline] |
Returns a read-only (constant) reverse iterator that points to the last element in the list. Iteration is done in reverse element order.
Definition at line 780 of file stl_list.h.
const_reverse_iterator std::list< _Tp, _Alloc >::crend | ( | ) | const [inline] |
Returns a read-only (constant) reverse iterator that points to one before the first element in the list. Iteration is done in reverse element order.
Definition at line 789 of file stl_list.h.
list< _Tp, _Alloc >::iterator list::emplace | ( | iterator | __position, | |
_Args &&... | __args | |||
) | [inline] |
Constructs object in list before specified iterator.
position | A const_iterator into the list. | |
args | Arguments. |
Definition at line 87 of file list.tcc.
References std::list< _Tp, _Alloc >::_M_create_node(), std::_List_iterator< _Tp >::_M_node, and std::_List_node_base::hook().
bool std::list< _Tp, _Alloc >::empty | ( | ) | const [inline] |
Returns true if the list is empty. (Thus begin() would equal end().)
Definition at line 799 of file stl_list.h.
Referenced by std::list< _Tp, _Alloc >::sort(), and std::list< _Tp, _Alloc >::splice().
const_iterator std::list< _Tp, _Alloc >::end | ( | ) | const [inline] |
Returns a read-only (constant) iterator that points one past the last element in the list. Iteration is done in ordinary element order.
Definition at line 716 of file stl_list.h.
iterator std::list< _Tp, _Alloc >::end | ( | ) | [inline] |
Returns a read/write iterator that points one past the last element in the list. Iteration is done in ordinary element order.
Definition at line 707 of file stl_list.h.
Referenced by std::list< _Tp, _Alloc >::list(), std::list< _Tp, _Alloc >::merge(), std::list< _Tp, _Alloc >::operator=(), std::operator==(), std::list< _Tp, _Alloc >::remove(), std::list< _Tp, _Alloc >::remove_if(), std::list< _Tp, _Alloc >::resize(), std::list< _Tp, _Alloc >::splice(), and std::list< _Tp, _Alloc >::unique().
iterator std::list< _Tp, _Alloc >::erase | ( | iterator | __first, | |
iterator | __last | |||
) | [inline] |
Remove a range of elements.
first | Iterator pointing to the first element to be erased. | |
last | Iterator pointing to one past the last element to be erased. |
This operation is linear time in the size of the range and only invalidates iterators/references to the element being removed. The user is also cautioned that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 1092 of file stl_list.h.
list< _Tp, _Alloc >::iterator list::erase | ( | iterator | __position | ) | [inline] |
Remove element at given position.
position | Iterator pointing to element to be erased. |
Due to the nature of a list this operation can be done in constant time, and only invalidates iterators/references to the element being removed. The user is also cautioned that this function only erases the element, and that if the element is itself a pointer, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 108 of file list.tcc.
References std::_List_node_base::_M_next, and std::_List_iterator< _Tp >::_M_node.
Referenced by std::list< _Tp, _Alloc >::operator=(), and std::list< _Tp, _Alloc >::resize().
const_reference std::list< _Tp, _Alloc >::front | ( | ) | const [inline] |
Returns a read-only (constant) reference to the data at the first element of the list.
Definition at line 839 of file stl_list.h.
reference std::list< _Tp, _Alloc >::front | ( | ) | [inline] |
Returns a read/write reference to the data at the first element of the list.
Definition at line 831 of file stl_list.h.
allocator_type std::list< _Tp, _Alloc >::get_allocator | ( | ) | const [inline] |
Get a copy of the memory allocation object.
Reimplemented from std::_List_base< _Tp, _Alloc >.
Definition at line 680 of file stl_list.h.
void std::list< _Tp, _Alloc >::insert | ( | iterator | __position, | |
_InputIterator | __first, | |||
_InputIterator | __last | |||
) | [inline] |
Inserts a range into the list.
This function will insert copies of the data in the range [first,last) into the list before the location specified by position.
This operation is linear in the number of elements inserted and does not invalidate iterators and references.
Definition at line 1048 of file stl_list.h.
void std::list< _Tp, _Alloc >::insert | ( | iterator | __position, | |
size_type | __n, | |||
const value_type & | __x | |||
) | [inline] |
Inserts a number of copies of given data into the list.
position | An iterator into the list. | |
n | Number of elements to be inserted. | |
x | Data to be inserted. |
This operation is linear in the number of elements inserted and does not invalidate iterators and references.
Definition at line 1027 of file stl_list.h.
void std::list< _Tp, _Alloc >::insert | ( | iterator | __p, | |
initializer_list< value_type > | __l | |||
) | [inline] |
Inserts the contents of an initializer_list into list before specified iterator.
p | An iterator into the list. | |
l | An initializer_list of value_type. |
This operation is linear in the number of elements inserted and does not invalidate iterators and references.
Definition at line 1010 of file stl_list.h.
References std::initializer_list< _E >::begin(), std::initializer_list< _E >::end(), and std::list< _Tp, _Alloc >::insert().
Referenced by std::list< _Tp, _Alloc >::insert().
iterator std::list< _Tp, _Alloc >::insert | ( | iterator | __position, | |
value_type && | __x | |||
) | [inline] |
Inserts given rvalue into list before specified iterator.
position | An iterator into the list. | |
x | Data to be inserted. |
Definition at line 993 of file stl_list.h.
References std::move().
list< _Tp, _Alloc >::iterator list::insert | ( | iterator | __position, | |
const value_type & | __x | |||
) | [inline] |
Inserts given value into list before specified iterator.
position | An iterator into the list. | |
x | Data to be inserted. |
Definition at line 98 of file list.tcc.
References std::list< _Tp, _Alloc >::_M_create_node(), std::_List_iterator< _Tp >::_M_node, and std::_List_node_base::hook().
Referenced by std::list< _Tp, _Alloc >::operator=(), and std::list< _Tp, _Alloc >::resize().
size_type std::list< _Tp, _Alloc >::max_size | ( | ) | const [inline] |
Returns the size() of the largest possible list.
Definition at line 809 of file stl_list.h.
void list::merge | ( | list< _Tp, _Alloc > && | __x, | |
_StrictWeakOrdering | __comp | |||
) | [inline] |
Merge sorted lists according to comparison function.
x | Sorted list to merge. | |
StrictWeakOrdering | Comparison function defining sort order. |
Definition at line 270 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), and std::list< _Tp, _Alloc >::end().
void list::merge | ( | list< _Tp, _Alloc > && | __x | ) | [inline] |
Merge sorted lists.
x | Sorted list to merge. |
Definition at line 236 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), and std::list< _Tp, _Alloc >::end().
Referenced by std::list< _Tp, _Alloc >::sort().
list& std::list< _Tp, _Alloc >::operator= | ( | initializer_list< value_type > | __l | ) | [inline] |
List initializer list assignment operator.
l | An initializer_list of value_type. |
Definition at line 623 of file stl_list.h.
References std::initializer_list< _E >::begin(), and std::initializer_list< _E >::end().
list& std::list< _Tp, _Alloc >::operator= | ( | list< _Tp, _Alloc > && | __x | ) | [inline] |
List move assignment operator.
x | A list of identical element and allocator types. |
Definition at line 607 of file stl_list.h.
list< _Tp, _Alloc > & list::operator= | ( | const list< _Tp, _Alloc > & | __x | ) | [inline] |
List assignment operator.
No explicit dtor needed as the _Base dtor takes care of things. The _Base dtor only erases the elements, and note that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
x | A list of identical element and allocator types. |
Definition at line 133 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), std::list< _Tp, _Alloc >::erase(), and std::list< _Tp, _Alloc >::insert().
void std::list< _Tp, _Alloc >::pop_back | ( | ) | [inline] |
Removes last element.
This is a typical stack operation. It shrinks the list by one. Due to the nature of a list this operation can be done in constant time, and only invalidates iterators/references to the element being removed.
Note that no data is returned, and if the last element's data is needed, it should be retrieved before pop_back() is called.
Definition at line 945 of file stl_list.h.
void std::list< _Tp, _Alloc >::pop_front | ( | ) | [inline] |
Removes first element.
This is a typical stack operation. It shrinks the list by one. Due to the nature of a list this operation can be done in constant time, and only invalidates iterators/references to the element being removed.
Note that no data is returned, and if the first element's data is needed, it should be retrieved before pop_front() is called.
Definition at line 905 of file stl_list.h.
void std::list< _Tp, _Alloc >::push_back | ( | const value_type & | __x | ) | [inline] |
Add data to the end of the list.
x | Data to be added. |
Definition at line 919 of file stl_list.h.
void std::list< _Tp, _Alloc >::push_front | ( | const value_type & | __x | ) | [inline] |
Add data to the front of the list.
x | Data to be added. |
Definition at line 878 of file stl_list.h.
const_reverse_iterator std::list< _Tp, _Alloc >::rbegin | ( | ) | const [inline] |
Returns a read-only (constant) reverse iterator that points to the last element in the list. Iteration is done in reverse element order.
Definition at line 734 of file stl_list.h.
reverse_iterator std::list< _Tp, _Alloc >::rbegin | ( | ) | [inline] |
Returns a read/write reverse iterator that points to the last element in the list. Iteration is done in reverse element order.
Definition at line 725 of file stl_list.h.
void list::remove | ( | const _Tp & | __value | ) | [inline] |
Remove all elements equal to value.
value | The value to remove. |
Definition at line 187 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), and std::list< _Tp, _Alloc >::end().
void list::remove_if | ( | _Predicate | __pred | ) | [inline] |
Remove all elements satisfying a predicate.
Predicate | Unary predicate function or object. |
Definition at line 340 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), and std::list< _Tp, _Alloc >::end().
const_reverse_iterator std::list< _Tp, _Alloc >::rend | ( | ) | const [inline] |
Returns a read-only (constant) reverse iterator that points to one before the first element in the list. Iteration is done in reverse element order.
Definition at line 752 of file stl_list.h.
reverse_iterator std::list< _Tp, _Alloc >::rend | ( | ) | [inline] |
Returns a read/write reverse iterator that points to one before the first element in the list. Iteration is done in reverse element order.
Definition at line 743 of file stl_list.h.
void list::resize | ( | size_type | __new_size, | |
value_type | __x = value_type() | |||
) | [inline] |
Resizes the list to the specified number of elements.
new_size | Number of elements the list should contain. | |
x | Data with which new elements should be populated. |
Definition at line 118 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), std::list< _Tp, _Alloc >::erase(), and std::list< _Tp, _Alloc >::insert().
void std::list< _Tp, _Alloc >::reverse | ( | ) | [inline] |
Reverse the elements in list.
Reverse the order of elements in the list in linear time.
Definition at line 1320 of file stl_list.h.
size_type std::list< _Tp, _Alloc >::size | ( | ) | const [inline] |
Returns the number of elements in the list.
Definition at line 804 of file stl_list.h.
References std::distance().
void list::sort | ( | _StrictWeakOrdering | __comp | ) | [inline] |
Sort the elements according to comparison function.
Sorts the elements of this list in NlogN time. Equivalent elements remain in list order.
Definition at line 379 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::empty(), std::list< _Tp, _Alloc >::merge(), std::list< _Tp, _Alloc >::splice(), and std::list< _Tp, _Alloc >::swap().
void list::sort | ( | ) | [inline] |
Sort the elements.
Sorts the elements of this list in NlogN time. Equivalent elements remain in list order.
Definition at line 302 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::empty(), std::list< _Tp, _Alloc >::merge(), std::list< _Tp, _Alloc >::splice(), and std::list< _Tp, _Alloc >::swap().
void std::list< _Tp, _Alloc >::splice | ( | iterator | __position, | |
list< _Tp, _Alloc > && | __x, | |||
iterator | __first, | |||
iterator | __last | |||
) | [inline] |
Insert range from another list.
position | Iterator referencing the element to insert before. | |
x | Source list. | |
first | Iterator referencing the start of range in x. | |
last | Iterator referencing the end of range in x. |
Undefined if position is in [first,last).
Definition at line 1204 of file stl_list.h.
void std::list< _Tp, _Alloc >::splice | ( | iterator | __position, | |
list< _Tp, _Alloc > && | __x, | |||
iterator | __i | |||
) | [inline] |
Insert element from another list.
position | Iterator referencing the element to insert before. | |
x | Source list. | |
i | Iterator referencing the element to move. |
Definition at line 1174 of file stl_list.h.
void std::list< _Tp, _Alloc >::splice | ( | iterator | __position, | |
list< _Tp, _Alloc > && | __x | |||
) | [inline] |
Insert contents of another list.
position | Iterator referencing the element to insert before. | |
x | Source list. |
Requires this != x.
Definition at line 1150 of file stl_list.h.
References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::empty(), and std::list< _Tp, _Alloc >::end().
Referenced by std::list< _Tp, _Alloc >::sort().
void std::list< _Tp, _Alloc >::swap | ( | list< _Tp, _Alloc > && | __x | ) | [inline] |
Swaps data with another list.
x | A list of the same element and allocator types. |
Definition at line 1110 of file stl_list.h.
References std::_List_base< _Tp, _Alloc >::_M_get_Node_allocator(), and std::_List_base< _Tp, _Alloc >::_M_impl.
Referenced by std::list< _Tp, _Alloc >::sort(), and std::swap().
void list::unique | ( | _BinaryPredicate | __binary_pred | ) | [inline] |
Remove consecutive elements satisfying a predicate.
BinaryPredicate | Binary predicate function or object. |
Definition at line 358 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), and std::list< _Tp, _Alloc >::end().
void list::unique | ( | ) | [inline] |
Remove consecutive duplicate elements.
For each consecutive set of elements with the same value, remove all but the first one. Remaining elements stay in list order. Note that this function only erases the elements, and that if the elements themselves are pointers, the pointed-to memory is not touched in any way. Managing the pointer is the user's responsibility.
Definition at line 215 of file list.tcc.
References std::list< _Tp, _Alloc >::begin(), and std::list< _Tp, _Alloc >::end().