__GNU_PBDS::DETAIL::PAIRING_HEAP(3)

✨ NAME ✨

__gnu_pbds::detail::pairing_heap< Value_Type, Cmp_Fn, _Alloc > — bestie, this is a pairing heap, and it lives in the libstdc++ Library Functions Manual. That's the whole name, no cap. 👑

---

🦋 SYNOPSIS 🦋

okay so first thing, you gotta pull it in like this:

#include <pairing_heap_.hpp>

and it does NOT stand on its own two feet, it's a nepo baby — it inherits from this:

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

---

💖 Public Types

the whole little family of type aliases it brings to the group chat:

• typedef _Alloc allocator_type
• typedef Cmp_Fn cmp_fn
• typedef base_type::const_iterator const_iterator
• typedef __rebind_a::const_pointer const_pointer
• typedef __rebind_a::const_reference const_reference
• typedef _Alloc::difference_type difference_type
• typedef base_type::iterator iterator
• typedef left_child_next_sibling_heap_node_< Value_Type, null_type, _Alloc > node
• typedef base_type::point_const_iterator point_const_iterator
• typedef base_type::point_iterator point_iterator
• typedef __rebind_a::pointer pointer
• typedef __rebind_a::reference reference
• typedef _Alloc::size_type size_type
• typedef Value_Type value_type

---

🌸 Public Member Functions

everything you can actually do with her, she's so versatile:

• pairing_heap (const Cmp_Fn &) — build one, hand her a comparator to vibe with
• pairing_heap (const pairing_heap &) — the copy constructor, twin energy
• iterator begin () — iterator to the beginning, non-const flavour
• const_iterator begin () const — same, but const, she's being careful
• void clear () — wipe it, nothing left
• bool empty () const — the vibe check: is she empty or not
• iterator end () — iterator to the end, non-const
• const_iterator end () const — end again, const edition
• void erase (point_iterator) — yeet the thing at that point iterator
• template<typename Pred> size_type erase_if (Pred) — erase whatever your predicate says yes to
• Cmp_Fn & get_cmp_fn () — hand back the comparator
• const Cmp_Fn & get_cmp_fn () const — same comparator, const mode
• void join (pairing_heap &) — merge another pairing heap in, it's giving teamwork
• size_type max_size () const — the absolute most she can hold
• void modify (point_iterator, const_reference) — change up the value sitting at that point iterator
• void pop () — drop the top
• point_iterator push (const_reference) — shove a new value in, get a point iterator back
• size_type size () const — how many are in there rn
• template<typename Pred> void split (Pred, pairing_heap &) — split off whatever the predicate picks out into another pairing heap
• void swap (left_child_next_sibling_heap< Value_Type, Cmp_Fn, null_type, _Alloc > &) — trade contents with the base heap
• void swap (pairing_heap &) — trade contents with another pairing heap
• const_reference top () const — peep the top without touching it

---

🔒 Protected Types

for the inner circle only:

• typedef alloc_traits::allocator_type node_allocator
• typedef alloc_traits::const_pointer node_const_pointer
• typedef null_type node_metadata
• typedef std::pair< node_pointer, node_pointer > node_pointer_pair

---

🔒 Protected Member Functions

the behind-the-scenes girlies, not for public consumption:

• void actual_erase_node (node_pointer)
• void bubble_to_top (node_pointer)
• void clear_imp (node_pointer)
• template<typename It> void copy_from_range (It, It)
• node_pointer get_new_node_for_insert (const_reference)
• node_pointer prune (Pred)
• void swap_with_parent (node_pointer, node_pointer)
• void to_linked_list ()
• void value_swap (left_child_next_sibling_heap &)

---

🔒 Static Protected Member Functions

these ones don't even need an object, they just are:

• static void make_child_of (node_pointer, node_pointer)
• static node_pointer parent (node_pointer)

---

🔒 Protected Attributes

the internals, the lore, the state:

• node_pointer m_p_root
• size_type m_size

---

💜 Detailed Description 💜

so, template time, say it with me:

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

and what is she, in four little words? "Pairing heap." 💅 that's it, that's the description, slay.

---

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. she wasn't hand-written by a human and honestly? iconic behaviour. 🙈

---

and that's a wrap bestie 🫶 this page came to you courtesy of libstdc++, from the Library Functions Manual — go forth and heap responsibly ✨🎀🦋