__GNU_PBDS::DETAIL::BINOMIAL_HEAP_BASE(3cxx)

📦
version 14-20240412 · 12 versions
, in ubuntu noble

💖 __gnu_pbds::detail::binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > 💖

okay bestie, welcome to the 3cxx manual page for this template. She's the base class for binomial heap, and she's giving template realness with Value_Type, Cmp_Fn, and _Alloc. slay ✨

🌸 NAME 🌸

__gnu_pbds::detail::binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > — Base class for binomial heap. periodt 💅

✨ SYNOPSIS ✨

the include is literally:

#include <binomial_heap_base_.hpp>

Inherits __gnu_pbds::detail::left_child_next_sibling_heap< Value_Type, Cmp_Fn, _Alloc::size_type, _Alloc >.

Inherited by __gnu_pbds::detail::binomial_heap< Value_Type, Cmp_Fn, _Alloc >, and __gnu_pbds::detail::rc_binomial_heap< Value_Type, Cmp_Fn, _Alloc >. 🫶

🫶 Public Types 🫶

these are the type aliases, no cap:

  • typedef _Alloc allocator_type — allocator type bestie
  • typedef Cmp_Fn cmp_fn — comparator type
  • typedef base_type::const_iterator const_iterator — const iterator type
  • typedef __rebind_v::const_pointer const_pointer — const pointer type
  • typedef __rebind_v::const_reference const_reference — const reference type
  • typedef _Alloc::difference_type difference_type — difference type
  • typedef base_type::iterator iterator — iterator type
  • typedef base_type::point_const_iterator point_const_iterator — point const iterator type
  • typedef base_type::point_iterator point_iterator — point iterator type
  • typedef __rebind_v::pointer pointer — pointer type
  • typedef __rebind_v::reference reference — reference type
  • typedef _Alloc::size_type size_type — size type
  • typedef Value_Type value_type — value type

💅 Public Member Functions 💅

every single one, in order, because we don't skip:

  • iterator begin () — begin iterator, non-const
  • const_iterator begin () const — begin iterator, const
  • void clear () — the clear one
  • bool empty () const — the empty check
  • iterator end () — end iterator, non-const
  • const_iterator end () const — end iterator, const
  • void erase (point_iterator) — erase via a point_iterator
  • template<typename Pred > size_type erase_if (Pred) — erase-if template with Pred
  • Cmp_Fn & get_cmp_fn () — grab the comparator, non-const
  • const Cmp_Fn & get_cmp_fn () const — grab the comparator, const
  • void join (binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — join with another binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &
  • size_type max_size () const — the max_size one
  • void modify (point_iterator, const_reference) — modify with point_iterator and const_reference
  • void pop () — the pop one
  • point_iterator push (const_reference) — push a const_reference
  • size_type size () const — the size one
  • template<typename Pred > void split (Pred, binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — split template with Pred and another binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &
  • void swap (left_child_next_sibling_heap< Value_Type, Cmp_Fn, _Alloc::size_type, _Alloc > &) — swap with left_child_next_sibling_heap< Value_Type, Cmp_Fn, _Alloc::size_type, _Alloc > &
  • const_reference top () const — peek the const_reference top

🎀 Protected Types 🎀

  • typedef base_type::node node — node type
  • typedef alloc_traits::allocator_type node_allocator — node allocator
  • typedef base_type::node_const_pointer node_const_pointer — const node pointer
  • typedef _Alloc::size_type node_metadata — node metadata
  • typedef base_type::node_pointer node_pointer — node pointer
  • typedef std::pair< node_pointer, node_pointer > node_pointer_pair — pair of node pointers

🧚 Protected Member Functions 🧚

  • binomial_heap_base (const binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — constructor taking const binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &
  • binomial_heap_base (const Cmp_Fn &) — constructor taking const Cmp_Fn &
  • void actual_erase_node (node_pointer) — the actual_erase_node one
  • void bubble_to_top (node_pointer) — the bubble_to_top one
  • void clear_imp (node_pointer) — the clear_imp one
  • template<typename It > void copy_from_range (It, It) — copy-from-range template with It
  • void find_max () — the find_max one
  • node_pointer get_new_node_for_insert (const_reference) — get a new node for insert from const_reference
  • node_pointer prune (Pred) — prune with Pred
  • void swap (binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — swap with binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &
  • void swap_with_parent (node_pointer, node_pointer) — swap with parent using two node_pointers
  • void to_linked_list () — the to_linked_list one
  • void value_swap (left_child_next_sibling_heap &) — value-swap with left_child_next_sibling_heap &

🌈 Static Protected Member Functions 🌈

  • static void make_child_of (node_pointer, node_pointer) — static make_child_of helper with two node_pointers
  • static node_pointer parent (node_pointer) — static parent helper with node_pointer

🍓 Protected Attributes 🍓

  • node_pointer m_p_max — the m_p_max node pointer
  • node_pointer m_p_root — the m_p_root node pointer
  • size_type m_size — the m_size size type

💜 Detailed Description 💜

the template declaration is literally:

template<typename Value_Type, typename Cmp_Fn, typename _Alloc>
class __gnu_pbds::detail::binomial_heap_base< Value_Type, Cmp_Fn, _Alloc >"Base class for binomial heap.

and the whole mood is: Base class for binomial heap. iconic, honestly.

✨ Author ✨

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

Signed off with forehead kisses 💖 from the 3cxx manual and libstdc++, generated automatically by Doxygen from the source code — date? this page doesn't list one, bestie, so that's the whole footer tea. 🫶✨

📦 where this page comes from