__GNU_PBDS::DETAIL::BINOMIAL_HEAP(3cxx)

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

okay so bestie, welcome to the 3cxx manual page for this binomial-heap template. It is giving deep library internals, and we are going to keep every single signature because that is the whole assignment. 💅

---

🌸 NAME 🌸

__gnu_pbds::detail::binomial_heap< Value_Type, Cmp_Fn, _Alloc > — this is the class this whole page is about, no cap.

---

✨ SYNOPSIS ✨

#include <binomial_heap_.hpp>

It inherits from __gnu_pbds::detail::binomial_heap_base< Value_Type, Cmp_Fn, _Alloc >.

🎀 Public Types 🎀

• typedef base_type::allocator_type allocator_type — the allocator type, handed down from base_type.
• typedef base_type::cmp_fn cmp_fn — the comparator type, also from base_type.
• typedef base_type::const_iterator const_iterator — the const iterator type from base_type.
• typedef base_type::const_pointer const_pointer — the const pointer type from base_type.
• typedef base_type::const_reference const_reference — the const reference type from base_type.
• typedef _Alloc::difference_type difference_type — the difference_type from _Alloc.
• typedef base_type::iterator iterator — the iterator type from base_type.
• typedef base_type::point_const_iterator point_const_iterator — the point const iterator type from base_type.
• typedef base_type::point_iterator point_iterator — the point iterator type from base_type.
• typedef base_type::pointer pointer — the pointer type from base_type.
• typedef base_type::reference reference — the reference type from base_type.
• typedef _Alloc::size_type size_type — the size_type from _Alloc.
• typedef Value_Type value_type — the value type, literally Value_Type.

💅 Public Member Functions 💅

• binomial_heap (const binomial_heap &) — copy-constructor energy; it takes another binomial_heap.
• binomial_heap (const Cmp_Fn &) — builds one from a Cmp_Fn.
• iterator begin () — gives you a regular iterator to the beginning.
• const_iterator begin () const — gives you a const_iterator to the beginning.
• void clear () — clears it out.
• bool empty () const — tells you whether it is empty.
• iterator end () — gives you a regular iterator to the end.
• const_iterator end () const — gives you a const_iterator to the end.
• void erase (point_iterator) — erases at a point_iterator.
• template<typename Pred > size_type erase_if (Pred) — the Pred-based erase-if situation, returning a size_type.
• Cmp_Fn & get_cmp_fn () — returns a non-const reference to the Cmp_Fn.
• const Cmp_Fn & get_cmp_fn () const — returns a const reference to the Cmp_Fn.
• void join (binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — joins with a binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &.
• size_type max_size () const — returns the max size as a size_type.
• void modify (point_iterator, const_reference) — modifies at a point_iterator, using a const_reference.
• void pop () — pops it.
• point_iterator push (const_reference) — pushes a const_reference and hands back a point_iterator.
• size_type size () const — returns the size as a size_type.
• template<typename Pred > void split (Pred, binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — splits using Pred, into a binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &.
• void swap (left_child_next_sibling_heap< Value_Type, Cmp_Fn, _Alloc::size_type, _Alloc > &) — swaps with a left_child_next_sibling_heap< Value_Type, Cmp_Fn, _Alloc::size_type, _Alloc > &.
• const_reference top () const — returns the top as a const_reference.

🦋 Protected Types 🦋

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

🌸 Protected Member Functions 🌸

• void actual_erase_node (node_pointer) — the actual erase-node helper, taking a node_pointer.
• void bubble_to_top (node_pointer) — bubbles a node_pointer to the top.
• void clear_imp (node_pointer) — the clear_imp helper, taking a node_pointer.
• template<typename It > void copy_from_range (It, It) — copies from an It range into another It.
• void find_max () — finds the max.
• node_pointer get_new_node_for_insert (const_reference) — gets a new node for insertion from a const_reference, returning a node_pointer.
• node_pointer prune (Pred) — prunes using Pred, returning a node_pointer.
• void swap (binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &) — swaps with a binomial_heap_base< Value_Type, Cmp_Fn, _Alloc > &.
• void swap_with_parent (node_pointer, node_pointer) — swaps with a parent, taking two node_pointers.
• void to_linked_list () — converts to a linked list.
• void value_swap (left_child_next_sibling_heap &) — swaps values with a left_child_next_sibling_heap &.

⭐ Static Protected Member Functions ⭐

• static void make_child_of (node_pointer, node_pointer) — static helper that makes one node_pointer a child of another node_pointer.
• static node_pointer parent (node_pointer) — static helper that takes a node_pointer and returns a node_pointer parent.

🍓 Protected Attributes 🍓

• node_pointer m_p_max — a node_pointer attribute named m_p_max.
• node_pointer m_p_root — a node_pointer attribute named m_p_root.
• size_type m_size — a size_type attribute 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 >

and the description is literally: Binomial heap.

---

👑 Author 👑

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

---

xoxo, your Unix bestie 💅 — source/version: libstdc++; the footer text is libstd__gnu_pbds::de...mp_Fn, _Alloc >(3cxx); date: the original footer does not print one, so I’m not gonna invent it, periodt. 🫶