__GNU_PBDS::DETAIL::LEFT_CHILD_NEXT_SIBLING_HEAP(3)

💖 NAME 💖

__gnu_pbds::detail::left_child_next_sibling_heap< Value_Type, Cmp_Fn, Node_Metadata, _Alloc > — it's the base class for a basic heap, bestie. That's the whole job description. It's giving "blueprint era" ✨

(also this page lives in the Library Functions Manual, just so you know where you wandered into 🫶)

---

✨ SYNOPSIS ✨

#include <left_child_next_sibling_heap_.hpp>

Inherited by __gnu_pbds::detail::pairing_heap< _VTp, Cmp_Fn, _Alloc >, and __gnu_pbds::detail::thin_heap< _VTp, Cmp_Fn, _Alloc >.

So yeah, these two are the nepo babies inheriting the whole vibe 💅

---

🌸 Public Types 🌸

• typedef _Alloc allocator_type — the allocator, wearing its allocator_type name tag 🎀
• typedef Cmp_Fn cmp_fn — the comparison function type, going by cmp_fn around here
• typedef left_child_next_sibling_heap_const_iterator_< node, _Alloc > const_iterator — the const iterator glow-up ⭐
• typedef __rebind_v::const_pointer const_pointer — a pointer that cannot and will not be changed, periodt
• typedef __rebind_v::const_reference const_reference — same energy but a reference 🦋
• typedef _Alloc::difference_type difference_type — for when you gotta measure the distance between things
• typedef const_iterator iterator — yup, the iterator is literally just the const_iterator here. no cap. that's the tea ☕
• typedef left_child_next_sibling_heap_node_< Value_Type, Node_Metadata, _Alloc > node — the node type, the main character of the data structure 👑
• typedef left_child_next_sibling_heap_node_point_const_iterator_< node, _Alloc > point_const_iterator — a const iterator that points at nodes directly 📍
• typedef point_const_iterator point_iterator — and the non-const-named version is literally the same type again. iconic 🙈
• typedef __rebind_v::pointer pointer — the regular pointer, no const in sight
• typedef __rebind_v::reference reference — a regular reference, living its best life
• typedef _Alloc::size_type size_type — the type for sizes, obviously
• typedef Value_Type value_type — the value type. the actual content. the substance 💖

---

💅 Public Member Functions 💅

• left_child_next_sibling_heap (const Cmp_Fn &) — constructor that takes a const Cmp_Fn & 🫶
• left_child_next_sibling_heap (const left_child_next_sibling_heap &) — the copy constructor, copying the whole thing
• iterator begin () — hands you an iterator pointing at the beginning
• const_iterator begin () const — same, but const, returns a const_iterator
• void clear () — wipes it. returns nothing. void. no notes ✨
• bool empty () const — const, returns a bool, tells you if it's empty
• iterator end () — the iterator for the end
• const_iterator end () const — const version, const_iterator, the end
• Cmp_Fn & get_cmp_fn () — hands you a non-const Cmp_Fn &
• const Cmp_Fn & get_cmp_fn () const — const overload, gives you a const Cmp_Fn &
• size_type max_size () const — const, gives you a size_type, the max size
• size_type size () const — const, gives you a size_type, the size
• void swap (left_child_next_sibling_heap< Value_Type, Cmp_Fn, Node_Metadata, _Alloc > &) — swaps with another one of these exact things, takes a reference, returns void 🔥

---

🎀 Protected Types 🎀

• typedef alloc_traits::allocator_type node_allocator — allocator but for nodes
• typedef alloc_traits::const_pointer node_const_pointer — const pointer, node edition
• typedef Node_Metadata node_metadata — the metadata, calling itself node_metadata
• typedef alloc_traits::pointer node_pointer — the pointer to a node. the classic
• typedef std::pair< node_pointer, node_pointer > node_pointer_pair — two node pointers, paired up, std::pair style 💞

---

🫶 Protected Member Functions 🫶

• void actual_erase_node (node_pointer) — takes a node_pointer, returns void. the actual one, allegedly 😭
• void bubble_to_top (node_pointer) — node_pointer in, void out. bubbling. to the top. as one does 🫧
• void clear_imp (node_pointer) — the implementation-flavoured clear, takes a node_pointer
• node_pointer get_new_node_for_insert (const_reference) — takes a const_reference, gives you back a fresh node_pointer
• template<typename Pred> node_pointer prune (Pred) — templated on Pred, takes a Pred, returns a node_pointer. pruning szn 🌿
• void swap_with_parent (node_pointer, node_pointer) — two node_pointers go in, void comes out, parent gets swapped
• void to_linked_list () — no args, void return, turns the whole thing into a linked list
• void value_swap (left_child_next_sibling_heap &) — takes a reference to one of these and swaps the values

---

🌟 Static Protected Member Functions 🌟

• static void make_child_of (node_pointer, node_pointer) — static, takes two node_pointers, returns void, makes one a child of the other 👶
• static node_pointer parent (node_pointer) — static, takes a node_pointer, returns the parent node_pointer 🧬

---

🦋 Protected Attributes 🦋

• node_pointer m_p_root — the root pointer. the anchor. the moment 🫶
• size_type m_size — the size. that's it. that's the attribute 💅

---

🔥 Detailed Description 🔥

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

Base class for a basic heap. That's the whole detailed description bestie, they really said "you get one sentence and it's a good one" 😭

---

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. So nobody hand-wrote this — the machine did it and honestly? it ate ✨

---

okay that's the whole page, bestie 💖 huge shoutout to libstdc++ for shipping this one to us, Doxygen-generated and everything, no date on the tin, just pure library-manual energy 🎀 slay, go build a heap, ily 🫶