STD::__PROFILE::FORWARD_LIST(3cxx)

📦
version 9.5.0 · 3 versions
, in ubuntu noble

💖 std::__profile::forward_list< _Tp, _Alloc > 💖

okay so bestie, welcome to the 3cxx corner of the manual 💅 this is the page for std::__profile::forward_list< _Tp, _Alloc > — the profiled glow-up of everybody's favourite singly-linked list. buckle up, we're going through everything, no skips, no skimming. ✨

🎀 NAME 🎀

std::__profile::forward_list< _Tp, _Alloc > — it's Class std::forward_list wrapper with performance instrumentation. yeah that's the whole job description, she wraps and she measures. 👑

✨ SYNOPSIS ✨

#include <forward_list>

Inherits forward_list< _Tp, std::allocator< _Tp > >. so like, she is a forward_list, she just also takes notes. 📝

🦋 Public Types 🦋

  • const_iterator — literally typedef _Base::const_iterator const_iterator. it's the base class's const iterator, re-exported, no new invention, no drama. 🫶
  • size_type — typedef _Base::size_type size_type. same story, borrowed straight from _Base so you never have to go hunting. 💅

🌸 Public Member Functions 🌸

okay this is the long part bestie, stay with me, every single one is here:

  • template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>> forward_list (_InputIterator __first, _InputIterator __last, const _Alloc &__al=_Alloc()) — build from a range of iterators, allocator optional. and yeah it's SFINAE-guarded with std::_RequireInputIter<_InputIterator> so only real input iterators get in. 🎀
  • forward_list (const _Alloc &__al) noexcept — hand it an allocator, that's it, that's the whole plot. marked noexcept. ✨
  • forward_list (const forward_list &)=default — copy ctor, defaulted, the compiler handles it. 💖
  • forward_list (const forward_list &__list, const _Alloc &__al) — copy with a specific allocator. yes, they're different, don't @ me. 🦋
  • forward_list (forward_list &&)=default — move ctor, defaulted. 🫶
  • forward_list (forward_list &&__list, const _Alloc &__al) — move, but with your allocator of choice. 💅
  • forward_list (size_type __n, const _Alloc &__al=_Alloc()) — __n default-constructed elements, allocator optional. 🌸
  • forward_list (size_type __n, const _Tp &__value, const _Alloc &__al=_Alloc()) — __n copies of __value, allocator optional. 🌈
  • forward_list (std::initializer_list< _Tp > __il, const _Alloc &__al=_Alloc()) — from a braced init list, allocator optional. iconic behaviour tbh. ⭐
  • const _Base & _M_base () const noexcept — const access to the underlying base object, noexcept. 💜
  • _Base & _M_base () noexcept — non-const access to the underlying base object, noexcept. the way she just hands you the base. 🔥
  • void merge (forward_list &&__list) — merge in an rvalue forward_list. 🍓
  • template<typename _Comp > void merge (forward_list &&__list, _Comp __comp) — same, but you bring your own comparator __comp. 🧚
  • void merge (forward_list &__list) — merge in an lvalue forward_list. 💖
  • template<typename _Comp > void merge (forward_list &__list, _Comp __comp) — lvalue merge, custom comparator, chef's kiss. 👑
  • forward_list & operator= (const forward_list &)=default — copy assignment, defaulted. ✨
  • forward_list & operator= (forward_list &&)=default — move assignment, defaulted. 🫶
  • forward_list & operator= (std::initializer_list< _Tp > __il) — assign from a braced init list. 🌸
  • void splice_after (const_iterator __pos, forward_list &&__fl) — splice everything from the rvalue __fl in after __pos. 🦋
  • void splice_after (const_iterator __pos, forward_list &&__list, const_iterator __before, const_iterator __last) — splice the range (__before, __last) from the rvalue __list, after __pos. yes, __before is exclusive, that's the _after of it all. 💅
  • void splice_after (const_iterator __pos, forward_list &&__list, const_iterator __i) — splice the single element after __i from the rvalue __list, after __pos. 🌈
  • void splice_after (const_iterator __pos, forward_list &__list) — lvalue flavour, whole list, after __pos. ⭐
  • void splice_after (const_iterator __pos, forward_list &__list, const_iterator __before, const_iterator __last) — lvalue flavour, range (__before, __last), after __pos. 🍓
  • void splice_after (const_iterator __pos, forward_list &__list, const_iterator __i) — lvalue flavour, single element after __i, after __pos. 🧚
  • void swap (forward_list &__fl) noexcept(noexcept(declval< _Base & >().swap(__fl))) — swap with __fl, and the noexcept spec is literally noexcept(noexcept(declval< _Base & >().swap(__fl))). she said "my exception guarantee is my base's exception guarantee". periodt. 💜

💅 Detailed Description 💅

the class template declaration is:

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

and the description is "Class std::forward_list wrapper with performance instrumentation." 🎀

Definition at line 44 of file profile/forward_list.

🎀 Member Typedef Documentation 🎀

  • template<typename _Tp , typename _Alloc = std::allocator<_Tp>> typedef _Base::const_iterator std::__profile::forward_list< _Tp, _Alloc >::const_iterator — Definition at line 51 of file profile/forward_list. 💖
  • template<typename _Tp , typename _Alloc = std::allocator<_Tp>> typedef _Base::size_type std::__profile::forward_list< _Tp, _Alloc >::size_type — Definition at line 50 of file profile/forward_list. 🦋

🌸 Constructor & Destructor Documentation 🌸

quick psa bestie: every single entry in this section is a member of the class template, so each one is prefixed with exactly this: cpp template<typename _Tp , typename _Alloc = std::allocator<_Tp>> keep it in mind for all seven of them, i'm not typing it seven times and neither should you. 💅
  • std::__profile::forward_list< _Tp, _Alloc >::forward_list (const _Alloc & __al) — [inline], [explicit], [noexcept]. Definition at line 58 of file profile/forward_list. ✨
  • std::__profile::forward_list< _Tp, _Alloc >::forward_list (const forward_list< _Tp, _Alloc > & __list, const _Alloc & __al) — [inline]. Definition at line 61 of file profile/forward_list. 🫶
  • std::__profile::forward_list< _Tp, _Alloc >::forward_list (forward_list< _Tp, _Alloc > && __list, const _Alloc & __al) — [inline]. Definition at line 65 of file profile/forward_list. 💖
  • std::__profile::forward_list< _Tp, _Alloc >::forward_list (size_type __n, const _Alloc & __al = _Alloc()) — [inline], [explicit]. Definition at line 70 of file profile/forward_list. 🌸
  • std::__profile::forward_list< _Tp, _Alloc >::forward_list (size_type __n, const _Tp & __value, const _Alloc & __al = _Alloc()) — [inline]. Definition at line 74 of file profile/forward_list. 🦋
  • template<typename _InputIterator , typename = std::_RequireInputIter<_InputIterator>> std::__profile::forward_list< _Tp, _Alloc >::forward_list (_InputIterator __first, _InputIterator __last, const _Alloc & __al = _Alloc()) — [inline]. Definition at line 81 of file profile/forward_list. 🌈
  • std::__profile::forward_list< _Tp, _Alloc >::forward_list (std::initializer_list< _Tp > __il, const _Alloc & __al = _Alloc()) — [inline]. Definition at line 89 of file profile/forward_list. ⭐

🔥 Member Function Documentation 🔥

same deal as before bestie: each one of these is a class-template member, so picture this in front of all of them: cpp template<typename _Tp , typename _Alloc = std::allocator<_Tp>> and the two merge entries with _Comp also carry their own extra template<typename _Comp > on top. 🎀
  • const _Base & std::__profile::forward_list< _Tp, _Alloc >::_M_base () const — [inline], [noexcept]. Definition at line 164 of file profile/forward_list. 💜
  • _Base & std::__profile::forward_list< _Tp, _Alloc >::_M_base () — [inline], [noexcept]. Definition at line 161 of file profile/forward_list. 💅
  • void std::__profile::forward_list< _Tp, _Alloc >::merge (forward_list< _Tp, _Alloc > && __list) — [inline]. Definition at line 143 of file profile/forward_list. 🍓
  • template<typename _Comp > void std::__profile::forward_list< _Tp, _Alloc >::merge (forward_list< _Tp, _Alloc > && __list, _Comp __comp) — [inline]. Definition at line 152 of file profile/forward_list. 🧚
  • void std::__profile::forward_list< _Tp, _Alloc >::merge (forward_list< _Tp, _Alloc > & __list) — [inline]. Definition at line 147 of file profile/forward_list. 💖
  • template<typename _Comp > void std::__profile::forward_list< _Tp, _Alloc >::merge (forward_list< _Tp, _Alloc > & __list, _Comp __comp) — [inline]. Definition at line 157 of file profile/forward_list. 🫶
  • forward_list & std::__profile::forward_list< _Tp, _Alloc >::operator= (std::initializer_list< _Tp > __il) — [inline]. Definition at line 103 of file profile/forward_list. ✨
  • void std::__profile::forward_list< _Tp, _Alloc >::splice_after (const_iterator __pos, forward_list< _Tp, _Alloc > && __fl) — [inline]. Definition at line 115 of file profile/forward_list. 🌸
  • void std::__profile::forward_list< _Tp, _Alloc >::splice_after (const_iterator __pos, forward_list< _Tp, _Alloc > && __list, const_iterator __before, const_iterator __last) — [inline]. Definition at line 133 of file profile/forward_list. 🦋
  • void std::__profile::forward_list< _Tp, _Alloc >::splice_after (const_iterator __pos, forward_list< _Tp, _Alloc > && __list, const_iterator __i) — [inline]. Definition at line 123 of file profile/forward_list. 🌈
  • void std::__profile::forward_list< _Tp, _Alloc >::splice_after (const_iterator __pos, forward_list< _Tp, _Alloc > & __list) — [inline]. Definition at line 119 of file profile/forward_list. ⭐
  • void std::__profile::forward_list< _Tp, _Alloc >::splice_after (const_iterator __pos, forward_list< _Tp, _Alloc > & __list, const_iterator __before, const_iterator __last) — [inline]. Definition at line 138 of file profile/forward_list. 🍓
  • void std::__profile::forward_list< _Tp, _Alloc >::splice_after (const_iterator __pos, forward_list< _Tp, _Alloc > & __list, const_iterator __i) — [inline]. Definition at line 128 of file profile/forward_list. 🧚
  • void std::__profile::forward_list< _Tp, _Alloc >::swap (forward_list< _Tp, _Alloc > & __fl) — [inline], [noexcept]. Definition at line 110 of file profile/forward_list. 💜

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. yeah, a robot wrote it, and honestly? she ate. 🤖💅

and that's the whole page bestie!! this one lives in the libstdc++ docs, manual section 3cxx — that's the manual name folded in right here instead of sitting on some boring header line, you're welcome — and there's no date stamped on it, so consider it timeless. go forth and profile your forward lists. mwah. 😘💖✨

📦 where this page comes from