__GNU_PBDS::DETAIL::BINOMIAL_HEAP(3)

💖 NAME 💖

__gnu_pbds::detail::binomial_heap< Value_Type, Cmp_Fn, _Alloc > — bestie, this is a page straight out of the Library Functions Manual, and we are gonna get into it. 🦋

---

✨ SYNOPSIS ✨

#include <binomial_heap_.hpp>

okay so the tea is that this class inherits __gnu_pbds::detail::binomial_heap_base< Value_Type, Cmp_Fn, _Alloc >. That's the whole lineage, no cap. 👑

---

🌸 Public Types 🌸

the glow-up starter pack — all the type aliases this class hands out to the public:

• typedef base_type::allocator_type allocator_type — the allocator type, courtesy of base_type
• typedef base_type::cmp_fn cmp_fn — the comparator type, straight from base_type
• typedef base_type::const_iterator const_iterator — const iterator, base_type's version
• typedef base_type::const_pointer const_pointer — const pointer, again from base_type
• typedef base_type::const_reference const_reference — const reference, base_type coded it
• typedef _Alloc::difference_type difference_type — difference type, and this one comes from _Alloc
• typedef base_type::iterator iterator — the regular iterator, base_type flavored
• typedef base_type::point_const_iterator point_const_iterator — point const iterator, from base_type
• typedef base_type::point_iterator point_iterator — point iterator, base_type said so
• typedef base_type::pointer pointer — pointer, base_type edition
• typedef base_type::reference reference — reference, base_type coded
• typedef _Alloc::size_type size_type — size type, and this one's from _Alloc
• typedef Value_Type value_type — value type, which is literally just Value_Type 💅

---

🎀 Public Member Functions 🎀

• binomial_heap (const binomial_heap &) — a constructor that takes a const binomial_heap &. copy-paste era
• binomial_heap (const Cmp_Fn &) — a constructor that takes a const Cmp_Fn &
• iterator begin () — takes nothing, gives you back an iterator
• void clear () — no args, no return, just void
• bool empty () const — const-qualified, returns bool
• iterator end () — no args in, iterator out
• void erase (point_iterator) — takes a point_iterator, returns void
• template<typename Pred> size_type erase_if (Pred) — templated on Pred, takes a Pred, hands back a size_type
• Cmp_Fn & get_cmp_fn () — no args, returns a reference to Cmp_Fn
• void join (binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — takes a reference to binomial_heap_base< Value_Type, Cmp_Fn, _Alloc >, returns void
• size_type max_size () const — const, returns size_type
• void modify (point_iterator, const_reference) — takes a point_iterator and a const_reference, returns void
• void pop () — nothing in, void out
• point_iterator push (const_reference) — takes a const_reference, gives you a point_iterator back
• size_type size () const — const-qualified, returns size_type
• template<typename Pred> void split (Pred, binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — templated on Pred, takes a Pred and a reference to binomial_heap_base< Value_Type, Cmp_Fn, _Alloc >, returns void
• void swap (left_child_next_sibling_heap< Value_Type, Cmp_Fn, _Alloc::size_type, _Alloc > &) — takes a reference to left_child_next_sibling_heap< Value_Type, Cmp_Fn, _Alloc::size_type, _Alloc >, returns void
• const_reference top () const — const, returns const_reference

---

💜 Protected Types 💜

family-only section, iykyk:

• typedef base_type::node node — node type, from base_type
• typedef alloc_traits::allocator_type node_allocator — node allocator, from alloc_traits
• typedef _Alloc::size_type node_metadata — node metadata, typed as _Alloc::size_type
• typedef std::pair< node_pointer, node_pointer > node_pointer_pair — a std::pair of two node_pointers

---

🧚 Protected Member Functions 🧚

• void actual_erase_node (node_pointer) — takes a node_pointer, returns void
• void bubble_to_top (node_pointer) — takes a node_pointer, returns void
• void clear_imp (node_pointer) — takes a node_pointer, returns void
• template<typename It> void copy_from_range (It, It) — templated on It, takes two Its, returns void
• void find_max () — no args, void return
• node_pointer get_new_node_for_insert (const_reference) — takes a const_reference, returns a node_pointer
• node_pointer prune (Pred) — takes a Pred, returns a node_pointer
• void swap (binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — takes a reference to binomial_heap_base< Value_Type, Cmp_Fn, _Alloc >, returns void
• void swap_with_parent (node_pointer, node_pointer) — takes two node_pointers, returns void
• void to_linked_list () — no args, void return
• void value_swap (left_child_next_sibling_heap &) — takes a reference to left_child_next_sibling_heap, returns void

---

⭐ Static Protected Member Functions ⭐

• static void make_child_of (node_pointer, node_pointer) — static, takes two node_pointers, returns void
• static node_pointer parent (node_pointer) — static, takes a node_pointer, returns a node_pointer

---

🍓 Protected Attributes 🍓

• node_pointer m_p_max — a node_pointer named m_p_max
• node_pointer m_p_root — a node_pointer named m_p_root
• size_type m_size — a size_type named m_size

---

🌈 Detailed Description 🌈

template<typename Value_Type, typename Cmp_Fn, typename _Alloc>
    class __gnu_pbds::detail::binomial_heap< Value_Type, Cmp_Fn, _Alloc >

Binomial heap.

and that's literally the entire detailed description, bestie. the docs said "Binomial heap." and then dipped. iconic honestly. 💀

---

👑 Author 👑

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

---

okay and that's the whole page!! 🫶 this one lives in the Library Functions Manual, it's part of the libstdc++ crew, and the author line is literally "Generated automatically by Doxygen for libstdc++ from the source code" — so yes, a robot wrote it, and honestly? it ate. 💅✨ go forth and heap, bestie!! 🦋🌸