__GNU_PBDS::PRIORITY_QUEUE(3)

🌸 NAME 🌸

__gnu_pbds::priority_queue< _Tv, Cmp_Fn, Tag, _Alloc > — bestie, it's a priority queue, but make it policy-based 💅

This page lives in the Library Functions Manual, section 3, and it's all about the libstdc++ <priority_queue.hpp> glow-up. Periodt.

---

✨ SYNOPSIS ✨

#include <priority_queue.hpp>

🎀 Public Types 🎀

Okay so here's the whole type roster, no skips, all of them:

• typedef _Alloc allocator_type — the allocator, but with a cuter name
• typedef Cmp_Fn cmp_fn — your comparison functor's alias era
• typedef base_type::const_iterator const_iterator — read-only iterator, main character but can't touch anything
• typedef __rebind_va::const_pointer const_pointer — const pointer, iconic
• typedef __rebind_va::const_reference const_reference — const reference, obsessed
• typedef Tag container_category — the Tag telling everyone which heap vibe this container is on
• typedef allocator_type::difference_type difference_type — difference type, for when you need to know how far
• typedef base_type::iterator iterator — the regular iterator, it can touch things
• typedef base_type::point_const_iterator point_const_iterator — const point iterator, iykyk
• typedef base_type::point_iterator point_iterator — point iterator, the one that points at your element fr fr
• typedef __rebind_va::pointer pointer — pointer 💖
• typedef __rebind_va::reference reference — reference 💖
• typedef allocator_type::size_type size_type — size type, for all your counting needs
• typedef _Tv value_type — the actual value type, the moment

🦋 Public Member Functions 🦋

• priority_queue (const cmp_fn &r_cmp_fn) — constructor that takes some policy objects. r_cmp_fn gets copied by the Cmp_Fn object of the container object. Not a drill.
• priority_queue (const priority_queue &other) — copy constructor, doing a little duplicate
• template<typename It> priority_queue (It first_it, It last_it) — constructor taking __iterators to a range of value_types. The value_types between first_it and last_it get inserted into the container object. Slay.
• template<typename It> priority_queue (It first_it, It last_it, const cmp_fn &r_cmp_fn) — constructor taking __iterators to a range of value_types and some policy objects. The value_types between first_it and last_it get inserted into the container object, and r_cmp_fn gets copied by the cmp_fn object of the container object.
• priority_queue & operator= (const priority_queue &other) — assignment operator, passing the vibe along
• void swap (priority_queue &other) — swap, the classic two-way trade 🤝

---

💜 Detailed Description 💜

template<typename _Tv, typename Cmp_Fn = std::less<_Tv>, typename Tag =
    pairing_heap_tag, typename _Alloc = std::allocator<char>>
class __gnu_pbds::priority_queue< _Tv, Cmp_Fn, Tag, _Alloc >

"A priority queue composed of one specific heap policy." That's the whole premise bestie, one queue, one heap policy, committed relationship energy.

🌈 Template Parameters 🌈

• _Tv — value type. The thing you're storing.
• Cmp_Fn — comparison functor. It decides who's actually more important.
• Tag — instantiating data structure type, see container_tag. This is the vibe selector.
• _Alloc — allocator type.

Base is dispatched at compile time via Tag, from the following choices: binary_heap_tag, binomial_heap_tag, pairing_heap_tag, rc_binomial_heap_tag, thin_heap_tag

Base choices are: detail::binary_heap, detail::binomial_heap, detail::pairing_heap, detail::rc_binomial_heap, detail::thin_heap.

---

🫶 Constructor & Destructor Documentation 🫶

priority_queue (const cmp_fn &r_cmp_fn) — constructor #1

template<typename _Tv, typename Cmp_Fn = std::less<_Tv>, typename Tag =
    pairing_heap_tag, typename _Alloc = std::allocator<char>>
__gnu_pbds::priority_queue< _Tv, Cmp_Fn, Tag, _Alloc >::priority_queue
(const cmp_fn & r_cmp_fn) [inline]

Constructor taking some policy objects. r_cmp_fn will be copied by the Cmp_Fn object of the container object. ✨

priority_queue (It first_it, It last_it) — constructor #2

template<typename _Tv, typename Cmp_Fn = std::less<_Tv>, typename Tag =
    pairing_heap_tag, typename _Alloc = std::allocator<char>>
template<typename It> __gnu_pbds::priority_queue< _Tv, Cmp_Fn, Tag,
_Alloc >::priority_queue (It first_it, It last_it) [inline]

Constructor taking __iterators to a range of value_types. The value_types between first_it and last_it will be inserted into the container object. 🎀

priority_queue (It first_it, It last_it, const cmp_fn &r_cmp_fn) — constructor #3

template<typename _Tv, typename Cmp_Fn = std::less<_Tv>, typename Tag =
    pairing_heap_tag, typename _Alloc = std::allocator<char>>
template<typename It> __gnu_pbds::priority_queue< _Tv, Cmp_Fn, Tag,
_Alloc >::priority_queue (It first_it, It last_it, const cmp_fn &
r_cmp_fn) [inline]

Constructor taking __iterators to a range of value_types and some policy objects. The value_types between first_it and last_it will be inserted into the container object. r_cmp_fn will be copied by the cmp_fn object of the container object. Two-for-one, we love to see it. 💅

Heads up bestie: the description literally reads "and some policy objects The value_types..." — no period in the original, so no period from me. Fidelity is the moment.

---

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. Not a human, just a very dedicated documentation robot doing its thing. 🤖

---

Okay that's the whole page, and as a lil sign-off: this came from libstdc++, it's filed under __gnu_pbds..., _Alloc >(3) in the Library Functions Manual, and there's no date on it so we're just gonna say timeless 🌟 mwah, go forth and heapify 💖