STD::LIST(3)

💖 std::list< _Tp, _Alloc >(3) — Library Functions Manual 💖

Okay bestie, this is the Library Functions Manual page for std::list< _Tp, _Alloc >. It’s giving standard container with linear time access to elements, and fixed time insertion/deletion at any point in the sequence. Periodt. 💅

---

🌸 NAME 🌸

std::list< _Tp, _Alloc > — A standard container with linear time access to elements, and fixed time insertion/deletion at any point in the sequence.

---

✨ SYNOPSIS ✨

#include <list>

Inherits std::_List_base< _Tp, _Alloc >.

---

🎀 Public Types 🎀

• typedef _Alloc allocator_type
• typedef _Node_traits::_Const_iterator const_iterator
• typedef _Tp_alloc_traits::const_pointer const_pointer
• typedef _Tp_alloc_traits::const_reference const_reference
• typedef std::reverse_iterator< const_iterator > const_reverse_iterator
• typedef ptrdiff_t difference_type
• typedef _Node_traits::_Iterator iterator
• typedef _Tp_alloc_traits::pointer pointer
• typedef _Tp_alloc_traits::reference reference
• typedef std::reverse_iterator< iterator > reverse_iterator
• typedef size_t size_type
• typedef _Tp value_type

---

💅 Public Member Functions 💅

• list() =default — Creates a list with no elements.
• template<typename _InputIterator, typename = std::_RequireInputIter<_InputIterator>> list (_InputIterator __first, _InputIterator __last, const allocator_type &__a=allocator_type()) — Builds a list from a range.
• list (const allocator_type &__a) noexcept — Creates a list with no elements.
• list (const list &__x) — List copy constructor.
• list (const list &__x, const __type_identity_t< allocator_type > &__a)
• list (initializer_list< value_type > __l, const allocator_type &__a=allocator_type()) — Builds a list from an initializer_list.
• list (list &&)=default — List move constructor.
• list (list &&__x, const __type_identity_t< allocator_type > &__a) noexcept(_Node_alloc_traits::_S_always_equal())
• list (size_type __n, const allocator_type &__a=allocator_type()) — Creates a list with default constructed elements.
• list (size_type __n, const value_type &__value, const allocator_type &__a=allocator_type()) — Creates a list with copies of an exemplar element.
• ~list ()=default
• template<typename _InputIterator, typename = std::_RequireInputIter<_InputIterator>> void assign (_InputIterator __first, _InputIterator __last) — Assigns a range to a list.
• void assign (initializer_list< value_type > __l) — Assigns an initializer_list to a list.
• void assign (size_type __n, const value_type &__val) — Assigns a given value to a list.
• const_reference back () const noexcept
• reference back () noexcept
• const_iterator begin () const noexcept
• iterator begin () noexcept
• const_iterator cbegin () const noexcept
• const_iterator cend () const noexcept
• void clear () noexcept
• const_reverse_iterator crbegin () const noexcept
• const_reverse_iterator crend () const noexcept
• template<typename... _Args> iterator emplace (const_iterator __position, _Args &&... __args) — Constructs object in list before specified iterator.
• template<typename... _Args> reference emplace_back (_Args &&... __args)
• template<typename... _Args> reference emplace_front (_Args &&... __args)
• bool empty () const noexcept
• const_iterator end () const noexcept
• iterator end () noexcept
• iterator erase (const_iterator __first, const_iterator __last) noexcept — Remove a range of elements.
• iterator erase (const_iterator __position) noexcept — Remove element at given position.
• const_reference front () const noexcept
• reference front () noexcept
• allocator_type get_allocator () const noexcept — Get a copy of the memory allocation object.
• iterator insert (const_iterator __p, initializer_list< value_type > __l) — Inserts the contents of an initializer_list into list before specified const_iterator.
• template<typename _InputIterator, typename = std::_RequireInputIter<_InputIterator>> iterator insert (const_iterator __position, _InputIterator __first, _InputIterator __last) — Inserts a range into the list.
• iterator insert (const_iterator __position, size_type __n, const value_type &__x) — Inserts a number of copies of given data into the list.
• size_type max_size () const noexcept
• void merge (list &&__x) — Merge sorted lists.
• template<typename _StrictWeakOrdering> void merge (list &&__x, _StrictWeakOrdering __comp) — Merge sorted lists according to comparison function.
• void merge (list &__x)
• template<typename _StrictWeakOrdering> void merge (list &__x, _StrictWeakOrdering __comp)
• list & operator= (const list &__x) — List assignment operator.
• list & operator= (initializer_list< value_type > __l) — List initializer list assignment operator.
• list & operator= (list &&__x) noexcept(_Node_alloc_traits::_S_nothrow_move()) — List move assignment operator.
• void pop_back () noexcept — Removes last element.
• void pop_front () noexcept — Removes first element.
• void push_back (const value_type &__x) — Add data to the end of the list.
• void push_back (value_type &&__x)
• void push_front (const value_type &__x) — Add data to the front of the list.
• void push_front (value_type &&__x)
• const_reverse_iterator rbegin () const noexcept
• reverse_iterator rbegin () noexcept
• __remove_return_type remove (const _Tp &__value) — Remove all elements equal to value.
• template<typename _Predicate> __remove_return_type remove_if (_Predicate) — Remove all elements satisfying a predicate.
• const_reverse_iterator rend () const noexcept
• reverse_iterator rend () noexcept
• void resize (size_type __new_size) — Resizes the list to the specified number of elements.
• void resize (size_type __new_size, const value_type &__x) — Resizes the list to the specified number of elements.
• void reverse () noexcept — Reverse the elements in list.
• size_type size () const noexcept
• void sort () — Sort the elements.
• template<typename _StrictWeakOrdering> void sort (_StrictWeakOrdering) — Sort the elements according to comparison function.
• void splice (const_iterator __position, list &&__x) noexcept — Insert contents of another list.
• void splice (const_iterator __position, list &&__x, const_iterator __first, const_iterator __last) noexcept — Insert range from another list.
• void splice (const_iterator __position, list &__x) noexcept
• void splice (const_iterator __position, list &__x, const_iterator __first, const_iterator __last) noexcept — Insert range from another list.
• void swap (list &__x) noexcept — Swaps data with another list.
• __remove_return_type unique () — Remove consecutive duplicate elements.
• template<typename _BinaryPredicate> __remove_return_type unique (_BinaryPredicate) — Remove consecutive elements satisfying a predicate.
  • iterator insert (const_iterator __position, const value_type &__x) — Inserts given value into list before specified iterator.
  • iterator insert (const_iterator __position, value_type &&__x) — Inserts given value into list before specified iterator.
  • void splice (const_iterator __position, list &&__x, const_iterator __i) noexcept — Insert element from another list.
  • void splice (const_iterator __position, list &__x, const_iterator __i) noexcept — Insert element from another list.

---

🧚 Protected Types 🧚

• typedef _Node_alloc_traits::pointer _Node_ptr

---

💖 Protected Member Functions 💖

• template<typename _InputIterator> void _M_assign_dispatch (_InputIterator __first, _InputIterator __last, __false_type)
• template<typename _Integer> void _M_assign_dispatch (_Integer __n, _Integer __val, __true_type)
• void _M_check_equal_allocators (const list &__x) noexcept
• void _M_clear () noexcept
• template<typename... _Args> _Node_ptr _M_create_node (_Args &&... __args)
• void _M_dec_size (size_t __n)
• void _M_default_append (size_type __n)
• void _M_default_initialize (size_type __n)
• void _M_destroy_node (_Node_ptr __p)
• size_t _M_distance (const __detail::_List_node_base *__first, const __detail::_List_node_base *__last) const
• void _M_erase (iterator __position) noexcept
• void _M_fill_assign (size_type __n, const value_type &__val)
• void _M_fill_initialize (size_type __n, const value_type &__x)
• _Node_alloc_traits::pointer _M_get_node ()
• const _Node_alloc_type & _M_get_Node_allocator () const noexcept
• _Node_alloc_type & _M_get_Node_allocator () noexcept
• size_t _M_get_size () const
• void _M_inc_size (size_t __n)
• void _M_init () noexcept
• template<typename _InputIterator> void _M_initialize_dispatch (_InputIterator __first, _InputIterator __last, __false_type)
• template<typename _Integer> void _M_initialize_dispatch (_Integer __n, _Integer __x, __true_type)
• template<typename... _Args> void _M_insert (iterator __position, _Args &&... __args)
• void _M_move_assign (list &&__x, false_type)
• void _M_move_assign (list &&__x, true_type) noexcept
• void _M_move_nodes (_List_base &&__x)
• size_t _M_node_count () const
• void _M_put_node (_Node_ptr __p) noexcept
• const_iterator _M_resize_pos (size_type &__new_size) const
• void _M_set_size (size_t __n)
• void _M_transfer (iterator __position, iterator __first, iterator __last)

---

🌈 Static Protected Member Functions 🌈

• static size_t _S_distance (const __detail::_List_node_base *__first, const __detail::_List_node_base *__last)
• static size_t _S_distance (const_iterator __first, const_iterator __last)

---

🦋 Protected Attributes 🦋

• _List_impl _M_impl

✨ Detailed Description ✨

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
class std::list< _Tp, _Alloc >

okay bestie, gather round, this is literally the whole vibe of the class: it's a standard container with linear time access to elements, and fixed time insertion/deletion at any point in the sequence. 💅

Template Parameters

• _Tp — Type of element.
• _Alloc — Allocator type, defaults to allocator<_Tp>.

It 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. iconic behavior, no cap ⭐

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

is actually circular; a link exists between A and D. The list class holds (as its only data member) a private list::iterator pointing to D, not to A! To get to the head of the list, we start at the tail and move forward by one. When this member iterator's next/previous pointers refer to itself, the list is empty. 🌀

---

🎀 Constructor & Destructor Documentation 🎀

std::list< _Tp, _Alloc >::list () [default]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::list ()

Creates a list with no elements. ✨

Referenced by erase(), insert(), insert(), insert(), merge(), merge(), operator=(), remove(), remove_if(), unique(), and unique().

---

std::list< _Tp, _Alloc >::list (const allocator_type & __a) [inline], [explicit], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::list (const allocator_type & __a)

Creates a list with no elements. 🫧

Parameters

• __a — An allocator object.

---

std::list< _Tp, _Alloc >::list (size_type __n, const allocator_type & __a = allocator_type()) [inline], [explicit]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::list (size_type __n, const allocator_type & __a = allocator_type())

Creates a list with default constructed elements. 🌸

Parameters

• __n — The number of elements to initially create.
• __a — An allocator object.

This constructor fills the list with __n default constructed elements.

---

std::list< _Tp, _Alloc >::list (size_type __n, const value_type & __value, const allocator_type & __a = allocator_type()) [inline]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::list (size_type __n, const value_type & __value, const allocator_type & __a = allocator_type())

Creates a list with copies of an exemplar element. 💖

Parameters

• __n — The number of elements to initially create.
• __value — An element to copy.
• __a — An allocator object.

This constructor fills the list with __n copies of __value.

---

std::list< _Tp, _Alloc >::list (const list< _Tp, _Alloc > & __x) [inline]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::list (const list< _Tp, _Alloc > & __x)

List copy constructor. 🦋

Parameters

• __x — A list of identical element and allocator types.

The newly-created list uses a copy of the allocation object used by __x (unless the allocator traits dictate a different object).

---

std::list< _Tp, _Alloc >::list (list< _Tp, _Alloc > && ) [default]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::list (list< _Tp, _Alloc > && )

List move constructor. The newly-created list contains the exact contents of the moved instance. The contents of the moved instance are a valid, but unspecified list. 👀

---

std::list< _Tp, _Alloc >::list (initializer_list< value_type > __l, const allocator_type & __a = allocator_type()) [inline]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::list (initializer_list< value_type > __l, const allocator_type & __a = allocator_type())

Builds a list from an initializer_list. ✨

Parameters

• __l — An initializer_list of value_type.
• __a — An allocator object.

Create a list consisting of copies of the elements in the initializer_list __l. This is linear in __l.size().

---

std::list< _Tp, _Alloc >::list (_InputIterator __first, _InputIterator __last, const allocator_type & __a = allocator_type()) [inline]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
template<typename _InputIterator, typename = std::_RequireInputIter<_InputIterator>>
std::list< _Tp, _Alloc >::list (_InputIterator __first, _InputIterator __last, const allocator_type & __a = allocator_type())

Builds a list from a range. 🌈

Parameters

• __first — An input iterator.
• __last — An input iterator.
• __a — An allocator object.

Create a list consisting of copies of the elements from [__first,__last). This is linear in N (where N is distance(__first,__last)).

---

std::list< _Tp, _Alloc >::~list () [default]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
std::list< _Tp, _Alloc >::~list ()

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. 🫣

---

💅 Member Function Documentation 💅

std::list< _Tp, _Alloc >::_M_create_node (_Args &&... __args) [inline], [protected]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
template<typename... _Args>
_Node_ptr std::list< _Tp, _Alloc >::_M_create_node (_Args &&... __args)

Parameters

• __args — An instance of user data.

Allocates space for a new node and constructs a copy of __args in it. 🧚

Referenced by emplace(), and insert().

---

std::list< _Tp, _Alloc >::assign (_InputIterator __first, _InputIterator __last) [inline]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
template<typename _InputIterator, typename = std::_RequireInputIter<_InputIterator>>
void std::list< _Tp, _Alloc >::assign (_InputIterator __first, _InputIterator __last)

Assigns a range to a list. 💜

Parameters

• __first — An input iterator.
• __last — An input iterator.

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.

---

std::list< _Tp, _Alloc >::assign (initializer_list< value_type > __l) [inline]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
void std::list< _Tp, _Alloc >::assign (initializer_list< value_type > __l)

Assigns an initializer_list to a list. 🍓

Parameters

• __l — An initializer_list of value_type.

Replace the contents of the list with copies of the elements in the initializer_list __l. This is linear in __l.size().

---

std::list< _Tp, _Alloc >::assign (size_type __n, const value_type & __val) [inline]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
void std::list< _Tp, _Alloc >::assign (size_type __n, const value_type & __val)

Assigns a given value to a list. ⭐

Parameters

• __n — Number of elements to be assigned.
• __val — Value to be assigned.

This function fills a list with __n copies of the given value. Note that the assignment completely changes the list and that the resulting list's size is the same as the number of elements assigned.

---

std::list< _Tp, _Alloc >::back () const [inline], [nodiscard], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
const_reference std::list< _Tp, _Alloc >::back () const

Returns a read-only (constant) reference to the data at the last element of the list. 🎀

---

std::list< _Tp, _Alloc >::back () [inline], [nodiscard], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
reference std::list< _Tp, _Alloc >::back ()

Returns a read/write reference to the data at the last element of the list. ✨

---

std::list< _Tp, _Alloc >::begin () const [inline], [nodiscard], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
const_iterator std::list< _Tp, _Alloc >::begin () const

Returns a read-only (constant) iterator that points to the first element in the list. Iteration is done in ordinary element order. 🦋

---

std::list< _Tp, _Alloc >::begin () [inline], [nodiscard], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
iterator std::list< _Tp, _Alloc >::begin ()

Returns a read/write iterator that points to the first element in the list. Iteration is done in ordinary element order. 💖

Referenced by std::list< _Tp, polymorphic_allocator< _Tp > >::list(), insert(), insert(), merge(), merge(), std::operator<=>(), operator=(), std::list< _Tp, polymorphic_allocator< _Tp > >::operator=(), remove(), remove_if(), std::list< _Tp, polymorphic_allocator< _Tp > >::splice(), unique(), and unique().

---

std::list< _Tp, _Alloc >::cbegin () const [inline], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
const_iterator std::list< _Tp, _Alloc >::cbegin () const

Returns a read-only (constant) iterator that points to the first element in the list. Iteration is done in ordinary element order. 🌸

---

std::list< _Tp, _Alloc >::cend () const [inline], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
const_iterator std::list< _Tp, _Alloc >::cend () const

Returns a read-only (constant) iterator that points one past the last element in the list. Iteration is done in ordinary element order. 🫶

---

std::list< _Tp, _Alloc >::clear () [inline], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
void std::list< _Tp, _Alloc >::clear ()

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. 🙈

Referenced by operator=().

---

std::list< _Tp, _Alloc >::crbegin () const [inline], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
const_reverse_iterator std::list< _Tp, _Alloc >::crbegin () const

Returns a read-only (constant) reverse iterator that points to the last element in the list. Iteration is done in reverse element order. 🌀

---

std::list< _Tp, _Alloc >::crend () const [inline], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
const_reverse_iterator std::list< _Tp, _Alloc >::crend () const

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. 💫

---

list::emplace (const_iterator __position, _Args &&... __args)

template<typename _Tp, typename _Alloc>
template<typename... _Args>
list< _Tp, _Alloc >::iterator list::emplace (const_iterator __position, _Args &&... __args)

Constructs object in list before specified iterator. 👑

Parameters

• __position — A const_iterator into the list.
• __args — Arguments.

Returns

An iterator that points to the inserted data.

This function will insert an object of type T constructed with T(std::forward<Args>(args)...) before the specified location. Due to the nature of a list this operation can be done in constant time, and does not invalidate iterators and references. 🔥

References _M_create_node(), and std::forward().

---

std::list< _Tp, _Alloc >::empty () const [inline], [nodiscard], [noexcept]

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
bool std::list< _Tp, _Alloc >::empty () const

Returns true if the list is empty. (Thus begin() would equal end().) 🎀

Referenced by insert(), and std::list< _Tp, polymorphic_allocator< _Tp > >::splice().

---

🦋 end() — the const version, aka "the finish line but make it read-only"

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> const_iterator
    std::list< _Tp, _Alloc >::end () const [inline],  [nodiscard],
    [noexcept]

Bestie, this one hands you a read-only (constant) iterator that points one past the last element in the list. Iteration is done in ordinary element order. It's the lil "you've hit the end, bestie, nothing to see here" marker 💖

---

🦋 end() — the read/write one, main character energy

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> iterator
    std::list< _Tp, _Alloc >::end () [inline],  [nodiscard],  [noexcept]

Same vibe, but read/write: returns an iterator that points one past the last element in the list. Iteration is done in ordinary element order. Periodt. ✨

Referenced by std::list< _Tp, polymorphic_allocator< _Tp > >::list(), merge(), merge(), std::operator<=>(), operator=(), std::list< _Tp, polymorphic_allocator< _Tp > >::operator=(), and std::list< _Tp, polymorphic_allocator< _Tp > >::splice().

---

💅 erase() — the range one, we're clearing a whole squad

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> iterator
    std::list< _Tp, _Alloc >::erase (const_iterator __first, const_iterator
    __last) [inline],  [noexcept]

Remove a range of elements. Slay, but responsibly.

Parameters

• __first — Iterator pointing to the first element to be erased.
• __last — Iterator pointing to one past the last element to be erased.

Returns

An iterator pointing to the element pointed to by last prior to erasing (or end()).

This function will erase the elements in the range [first,last) and shorten the list accordingly.

This operation is linear time in the size of the range, and it 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. 🫡

---

💅 erase() — the single-position one, constant time icon

template<typename _Tp, typename _Alloc> list< _Tp, _Alloc >::iterator
    list::erase (const_iterator __position) [noexcept]

Remove element at given position.

Parameters

• __position — Iterator pointing to element to be erased.

Returns

An iterator pointing to the next element (or end()).

This function will erase the element at the given position and thus shorten the list by one.

Due to the nature of a list this operation can be done in constant time, and it 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. 😭

References list(), and erase().

Referenced by erase(), resize(), and resize().

---

🎀 front() — the const version, peeking at the first lil guy

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
    const_reference std::list< _Tp, _Alloc >::front () const [inline],
    [nodiscard],  [noexcept]

Returns a read-only (constant) reference to the data at the first element of the list. Look, don't touch. 👀

---

🎀 front() — the read/write version, we're editing now

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> reference
    std::list< _Tp, _Alloc >::front () [inline],  [nodiscard],  [noexcept]

Returns a read/write reference to the data at the first element of the list. Go ahead, change it, it's yours. 💅

---

🌸 get_allocator() — the memory plug, copy it and keep it

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> allocator_type
    std::list< _Tp, _Alloc >::get_allocator () const [inline],  [noexcept]

Get a copy of the memory allocation object. That's it, that's the whole thing. ✨

Referenced by insert(), insert(), remove(), remove_if(), unique(), and unique().

---

🌈 insert() — the initializer_list one, feeding it a lil bundle

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> iterator
    std::list< _Tp, _Alloc >::insert (const_iterator __p, initializer_list<
    value_type > __l) [inline]

Inserts the contents of an initializer_list into the list before the specified const_iterator.

Parameters

• __p — A const_iterator into the list.
• __l — An initializer_list of value_type.

Returns

An iterator pointing to the first element inserted (or __p).

This function will insert copies of the data in the initializer_list __l into the list before the location specified by __p.

This operation is linear in the number of elements inserted, and it does not invalidate iterators and references. 💖

---

🌈 insert() — the input-iterator range one, bring the whole crew

template<typename _Tp, typename _Alloc> template<typename _InputIterator,
    typename> list< _Tp, _Alloc >::iterator list::insert (const_iterator
    __position, _InputIterator __first, _InputIterator __last)

Inserts a range into the list.

Parameters

• __position — An iterator into the list.
• __first — An input iterator.
• __last — An input iterator.

Returns

Since C++11, an iterator pointing to the first element inserted (or __position). In C++98 this returns void. (iykyk 😭)

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 it does not invalidate iterators and references.

References list(), begin(), empty(), get_allocator(), and splice().

---

🌈 insert() — the single-value one, constant time bestie

template<typename _Tp, typename _Alloc> list< _Tp, _Alloc >::iterator
    list::insert (const_iterator __position, const value_type & __x)

Inserts the given value into the list before the specified iterator.

Parameters

• __position — An iterator into the list.
• __x — Data to be inserted.

Returns

An iterator that points to the inserted data.

This function will insert a copy of the given value before the specified location. Due to the nature of a list this operation can be done in constant time, and it does not invalidate iterators and references. Iconic behaviour, honestly. 👑

References list(), _M_create_node(), and insert().

Referenced by insert(), and resize().

---

🌈 insert() — the "n copies of the same thing" one

template<typename _Tp, typename _Alloc> list< _Tp, _Alloc >::iterator
    list::insert (const_iterator __position, size_type __n, const value_type
    & __x)

Inserts a number of copies of given data into the list. It's giving "buy one, get __n-1 free". 🛍️

Parameters

• __position — An iterator into the list.
• __n — Number of elements to be inserted.
• __x — Data to be inserted.

Returns

Since C++11, an iterator pointing to the first element inserted (or __position). In C++98 this returns void. (C++98 girlies, we see you 🙈)

This function will insert a specified number of copies of the given data before the location specified by __position.

This operation is linear in the number of elements inserted, and it does not invalidate iterators and references.

References list(), begin(), get_allocator(), and splice().

---

🌈 insert() — the rvalue one, moving it in with zero copying

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> iterator
    std::list< _Tp, _Alloc >::insert (const_iterator __position, value_type
    && __x) [inline]

Inserts the given value into the list before the specified iterator.

Parameters

• __position — An iterator into the list.
• __x — Data to be inserted.

Returns

An iterator that points to the inserted data.

This function will insert a copy of the given value before the specified location. Due to the nature of a list this operation can be done in constant time, and it does not invalidate iterators and references. 💖

---

⭐ max_size() — the absolute ceiling, the limit, the cap

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> size_type
    std::list< _Tp, _Alloc >::max_size () const [inline],  [nodiscard],
    [noexcept]

Returns the size() of the largest possible list. That's the whole vibe check. 🌈

---

🔥 merge() — merging two sorted lists, no comparison function, just vibes (and operator<)

template<typename _Tp, typename _Alloc> void list::merge (list< _Tp, _Alloc
    > && __x)

Merge sorted lists.

Parameters

• __x — Sorted list to merge.

Assumes that both __x and this list are sorted according to operator<(). Merges elements of __x into this list in sorted order, leaving __x empty when complete. Elements in this list precede elements in __x that are equal. (Yes, this list wins the tie. Main character energy. 👑)

References list(), std::__addressof(), std::begin(), begin(), std::end(), end(), and merge().

Referenced by merge(), and merge().

---

🔥 merge() — merging with your own comparison function, custom order slay

template<typename _Tp, typename _Alloc> template<typename
    _StrictWeakOrdering> void list::merge (list< _Tp, _Alloc > && __x,
    _StrictWeakOrdering __comp)

Merge sorted lists according to comparison function.

Template Parameters

• _StrictWeakOrdering — Comparison function defining sort order.

Parameters

• __x — Sorted list to merge.
• __comp — Comparison functor.

Assumes that both __x and this list are sorted according to StrictWeakOrdering. Merges elements of __x into this list in sorted order, leaving __x empty when complete. Elements in this list precede elements in __x that are equivalent according to StrictWeakOrdering(). ✨

References list(), std::__addressof(), std::begin(), begin(), std::end(), end(), and merge().

---

🫶 operator= — the copy assignment one, dupe the whole thing

template<typename _Tp, typename _Alloc> list< _Tp, _Alloc > &
    list::operator= (const list< _Tp, _Alloc > & __x)

List assignment operator.

Parameters

• __x — A list of identical element and allocator types.

All the elements of __x are copied.

Whether the allocator is copied depends on the allocator traits. (Mysterious. We love that for it. 💅)

References list(), std::__addressof(), begin(), clear(), and end().

---

🫶 operator= — the initializer_list one, swap out the whole contents

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> list &
    std::list< _Tp, _Alloc >::operator= (initializer_list< value_type > __l)
    [inline]

List initializer list assignment operator.

Parameters

• __l — An initializer_list of value_type.

Replace the contents of the list with copies of the elements in the initializer_list __l. This is linear in l.size(). 📏

---

🫶 operator= — the move assignment one, zero copying, all speed

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> list &
    std::list< _Tp, _Alloc >::operator= (list< _Tp, _Alloc > && __x)
    [inline],  [noexcept]

List move assignment operator.

Parameters

• __x — A list of identical element and allocator types.

The contents of __x are moved into this list (without copying). 🏃‍♀️💨

Afterwards __x is a valid, but unspecified list. (It's fine. It's fine. Don't look at it. 🙈)

Whether the allocator is moved depends on the allocator traits.

---

💀 pop_back() — bye bye last element

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::pop_back () [inline],  [noexcept]

Removes the 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 it only invalidates iterators/references to the element being removed.

Note: no data is returned, and if the last element's data is needed, it should be retrieved before pop_back() is called. Grab it first, bestie, or it's gone forever 😭

---

💀 pop_front() — bye bye first element

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::pop_front () [inline],  [noexcept]

Removes the 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 it only invalidates iterators/references to the element being removed.

Note: no data is returned, and if the first element's data is needed, it should be retrieved before pop_front() is called. Same deal as above, no take-backs. 🫠

---

🍓 push_back() — adding data to the end, the classic

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::push_back (const value_type & __x) [inline]

Add data to the end of the list.

Parameters

• __x — Data to be added.

okay so continuing on push_back real quick, bestie 🥞 — it's a typical stack operation. the function creates an element at the end of the list and assigns the given data to it. and because a list is a list, this whole thing is constant time, and it does NOT invalidate iterators and references. your iterators are safe. your refs are safe. we love a low-risk queen 💅

---

🎀 push_front 🎀

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::push_front (const value_type & __x) [inline]

Add data to the front of the list.

Parameters

• __x — Data to be added.

This is a typical stack operation. The function creates an element at the front of the list and assigns the given data to it. Due to the nature of a list this operation can be done in constant time, and does not invalidate iterators and references. no cap, it just slides in at the front like it owns the place 👑

---

🦋 rbegin (const) 🦋

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
    const_reverse_iterator std::list< _Tp, _Alloc >::rbegin () const
    [inline], [nodiscard], [noexcept]

Returns a read-only (constant) reverse iterator that points to the last element in the list. Iteration is done in reverse element order. it's giving backwards main character energy 🌈

🦋 rbegin 🦋

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
    reverse_iterator std::list< _Tp, _Alloc >::rbegin () [inline],
    [nodiscard], [noexcept]

Returns a read/write reverse iterator that points to the last element in the list. Iteration is done in reverse element order. same vibe, but you're allowed to touch things this time ✨

---

💀 remove 💀

template<typename _Tp, typename _Alloc> list< _Tp, _Alloc
    >::__remove_return_type list::remove (const _Tp & __value)

Remove all elements equal to value.

Parameters

• __value — The value to remove.

Removes every element in the list equal to value. 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. 🫡

References: list(), std::begin(), begin(), std::end(), get_allocator(), size(), and splice().

🔥 remove_if 🔥

template<typename _Tp, typename _Alloc> template<typename _Predicate> list<
    _Tp, _Alloc >::__remove_return_type list::remove_if (_Predicate __pred)

Remove all elements satisfying a predicate.

Template Parameters

• _Predicate — Unary predicate function or object.

Removes every element in the list for which the predicate returns true. 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. the predicate decides who gets evicted, and it does not clean up after you 😭

References: list(), std::begin(), begin(), std::end(), get_allocator(), size(), and splice().

---

🌸 rend (const) 🌸

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
    const_reverse_iterator std::list< _Tp, _Alloc >::rend () const [inline],
    [nodiscard], [noexcept]

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. yes it's one before the first, that's not a typo, that's just how reverse iterators do 💫

🌸 rend 🌸

template<typename _Tp, typename _Alloc = std::allocator<_Tp>>
    reverse_iterator std::list< _Tp, _Alloc >::rend () [inline],
    [nodiscard], [noexcept]

Returns a read/write reverse iterator that points to one before the first element in the list. Iteration is done in reverse element order. periodt. 💅

---

🎀 resize (one arg) 🎀

template<typename _Tp, typename _Alloc> void list::resize (size_type
    __new_size)

Resizes the list to the specified number of elements.

Parameters

• __new_size — Number of elements the list should contain.

This function will resize the list to the specified number of elements. If the number is smaller than the list's current size the list is truncated, otherwise default constructed elements are appended. glow up or glow down, the list decides ✨

References: std::end(), and erase().

🎀 resize (two args) 🎀

template<typename _Tp, typename _Alloc> void list::resize (size_type
    __new_size, const value_type & __x)

Resizes the list to the specified number of elements.

Parameters

• __new_size — Number of elements the list should contain.
• __x — Data with which new elements should be populated.

This function will resize the list to the specified number of elements. If the number is smaller than the list's current size the list is truncated, otherwise the list is extended and new elements are populated with given data. same deal, but the new babies all get the same outfit 👯

References: std::end(), erase(), and insert().

---

🧚 reverse 🧚

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::reverse () [inline], [noexcept]

Reverse the elements in list. Reverse the order of elements in the list in linear time. the whole list does a 180 and honestly? iconic. 🔄

---

👑 size 👑

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> size_type
    std::list< _Tp, _Alloc >::size () const [inline], [nodiscard],
    [noexcept]

Returns the number of elements in the list.

Referenced by std::operator<=>(), remove(), remove_if(), unique(), and unique().

---

💖 sort (no args) 💖

template<typename _Tp, typename _Alloc> void list::sort ()

Sort the elements. Sorts the elements of this list in NlogN time. Equivalent elements remain in list order. yes bestie, it's stable, we love a stable sort 🫶

References: std::begin(), std::empty(), and std::end().

💖 sort (with a comparator) 💖

template<typename _Tp, typename _Alloc> template<typename
    _StrictWeakOrdering> void list::sort (_StrictWeakOrdering __comp)

Sort the elements according to comparison function. Sorts the elements of this list in NlogN time. Equivalent elements remain in list order. you bring the vibes, __comp brings the rules 📏

References: std::begin(), std::empty(), and std::end().

---

🌈 splice — move a whole list in 🌈

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::splice (const_iterator __position, list< _Tp,
    _Alloc > && __x) [inline], [noexcept]

Insert contents of another list.

Parameters

• __position — Iterator referencing the element to insert before.
• __x — Source list.

The elements of __x are inserted in constant time in front of the element referenced by __position. __x becomes an empty list. it literally hands over its whole personality and walks away empty 😭

Requires: this != __x. do not try to splice a list into itself, bestie, that's not a vibe check that's a disaster.

Referenced by insert(), insert(), remove(), remove_if(), unique(), and unique().

🌈 splice — move a range from an rvalue list 🌈

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::splice (const_iterator __position, list< _Tp,
    _Alloc > && __x, const_iterator __first, const_iterator __last)
    [inline], [noexcept]

Insert range from another list.

Parameters

• __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.

Removes elements in the range [__first,__last) and inserts them before __position in constant time.

Undefined if __position is in [__first,__last). fr fr, don't do it. 💀

🌈 splice — move one element from an rvalue list 🌈

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::splice (const_iterator __position, list< _Tp,
    _Alloc > && __x, const_iterator __i) [inline], [noexcept]

Insert element from another list.

Parameters

• __position — Iterator referencing the element to insert before.
• __x — Source list.
• __i — Iterator referencing the element to move.

Removes the element in list __x referenced by __i and inserts it into the current list before __position. one single element getting plucked out and relocated, main character behaviour 🎀

🌈 splice — move a range from an lvalue list 🌈

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::splice (const_iterator __position, list< _Tp,
    _Alloc > & __x, const_iterator __first, const_iterator __last) [inline],
    [noexcept]

Insert range from another list.

Parameters

• __position — Const_iterator referencing the element to insert before.
• __x — Source list.
• __first — Const_iterator referencing the start of range in x.
• __last — Const_iterator referencing the end of range in x.

Removes elements in the range [__first,__last) and inserts them before __position in constant time.

Undefined if __position is in [__first,__last). same warning, same energy, still don't. 🙈

🌈 splice — move one element from an lvalue list 🌈

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::splice (const_iterator __position, list< _Tp,
    _Alloc > & __x, const_iterator __i) [inline], [noexcept]

Insert element from another list.

Parameters

• __position — Iterator referencing the element to insert before.
• __x — Source list.
• __i — Iterator referencing the element to move.

Removes the element in list __x referenced by __i and inserts it into the current list before __position. yep, same as the && one, just with an lvalue reference bestie, keep up 💅

---

🍓 swap 🍓

template<typename _Tp, typename _Alloc = std::allocator<_Tp>> void
    std::list< _Tp, _Alloc >::swap (list< _Tp, _Alloc > & __x) [inline],
    [noexcept]

Swaps data with another list.

Parameters

• __x — A list of the same element and allocator types.

This exchanges the elements between two lists in constant time. Note that the global std::swap() function is specialized such that std::swap(l1,l2) will feed to this function. 🎁

Whether the allocators are swapped depends on the allocator traits. it's giving "it depends", sorry bestie, that's just the truth.

---

⭐ unique (no args) ⭐

template<typename _Tp, typename _Alloc> list< _Tp, _Alloc
    >::__remove_return_type list::unique ()

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. consecutive only, okay?? it is not going to hunt down duplicates across the whole list, that's not what she does 💅

References: list(), std::begin(), begin(), std::end(), get_allocator(), size(), and splice().

⭐ unique (with a predicate) ⭐

template<typename _Tp, typename _Alloc> template<typename _BinaryPredicate>
    list< _Tp, _Alloc >::__remove_return_type list::unique (_BinaryPredicate
    __binary_pred)

Remove consecutive elements satisfying a predicate.

Template Parameters

• _BinaryPredicate — Binary predicate function or object.

For each consecutive set of elements [first,last) that satisfy predicate(first,i) where i is an iterator in [first,last), 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. 🫶

References: list(), std::begin(), begin(), std::end(), get_allocator(), size(), and splice().

---

📝 Author 📝

Generated automatically by Doxygen for libstdc++ from the source code.

---

and that's the whole page, bestie 🎀 this little masterpiece came to you from libstdc++, and it's literally titled std::list< _Tp, _Alloc >(3) — no date on the footer, just the source and the name, and honestly? she said "my work speaks for itself." go forth and splice, you absolute icon 💖✨