HEAP_ALGORITHMS(3)

📦 version 4.4.0, in nixpkgs unstable

🫶 Heap Algorithms(3) 🫶

okay so bestie, welcome to Heap Algorithms(3) from the Library Functions Manual — this is the C++ heap algorithm friend group, and yes they're all templates, and yes they ate. 💅

✨ NAME ✨

Heap Algorithms — literally the heap ops, no cap. Here's the whole function lineup:

🧸 Functions 🧸

  • template<typename _RandomAccessIterator , typename _Compare > bool std::is_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp)
  • template<typename _RandomAccessIterator > bool std::is_heap (_RandomAccessIterator __first, _RandomAccessIterator __last)
  • template<typename _RandomAccessIterator , typename _Compare > _RandomAccessIterator std::is_heap_until (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp)
  • template<typename _RandomAccessIterator > _RandomAccessIterator std::is_heap_until (_RandomAccessIterator __first, _RandomAccessIterator __last)
  • template<typename _RandomAccessIterator , typename _Compare > void std::make_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp)
  • template<typename _RandomAccessIterator > void std::make_heap (_RandomAccessIterator __first, _RandomAccessIterator __last)
  • template<typename _RandomAccessIterator , typename _Compare > void std::pop_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp)
  • template<typename _RandomAccessIterator > void std::pop_heap (_RandomAccessIterator __first, _RandomAccessIterator __last)
  • template<typename _RandomAccessIterator , typename _Compare > void std::push_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp)
  • template<typename _RandomAccessIterator > void std::push_heap (_RandomAccessIterator __first, _RandomAccessIterator __last)
  • template<typename _RandomAccessIterator , typename _Compare > void std::sort_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp)
  • template<typename _RandomAccessIterator > void std::sort_heap (_RandomAccessIterator __first, _RandomAccessIterator __last)

🌸 Function Documentation 🌸

🦋 std::is_heap — with _Compare 🦋

template<typename _RandomAccessIterator , typename _Compare > bool std::is_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp) [inline]

This one determines whether a range is a heap, using your comparison functor. It's the heap vibe check with _Compare, fr fr.

Parameters:

  • first — Start of range.
  • last — End of range.
  • comp — Comparison functor to use.

Returns: True if range is a heap, false otherwise.

Definition at line 571 of file stl_heap.h.

References: std::is_heap_until().

🦋 std::is_heap — no _Compare 🦋

template<typename _RandomAccessIterator > bool std::is_heap (_RandomAccessIterator __first, _RandomAccessIterator __last) [inline]

This one determines whether a range is a heap. No custom comparator here — just the range, bestie.

Parameters:

  • first — Start of range.
  • last — End of range.

Returns: True if range is a heap, false otherwise.

Definition at line 558 of file stl_heap.h.

References: std::is_heap_until().

🦋 std::is_heap_until — with _Compare 🦋

template<typename _RandomAccessIterator , typename _Compare > _RandomAccessIterator std::is_heap_until (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp) [inline]

Search for the end of a heap, using your comparison functor. It's giving "where does the heap energy stop."

Parameters:

  • first — Start of range.
  • last — End of range.
  • comp — Comparison functor to use.

Returns: An iterator pointing to the first element not in the heap.

okay so this operation returns the last iterator i in [first, last) for which the range [first, i) is a heap. Comparisons are made using comp.

Definition at line 536 of file stl_heap.h.

References: std::distance().

Referenced by: std::is_heap().

🦋 std::is_heap_until — no _Compare 🦋

template<typename _RandomAccessIterator > _RandomAccessIterator std::is_heap_until (_RandomAccessIterator __first, _RandomAccessIterator __last) [inline]

Search for the end of a heap. No custom comparator, just the range.

Parameters:

  • first — Start of range.
  • last — End of range.

Returns: An iterator pointing to the first element not in the heap.

This operation returns the last iterator i in [first, last) for which the range [first, i) is a heap.

Definition at line 510 of file stl_heap.h.

References: std::distance().

🦋 std::make_heap — with _Compare 🦋

template<typename _RandomAccessIterator , typename _Compare > void std::make_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp) [inline]

Construct a heap over a range, using your comparison functor. This is the glow-up moment where your range becomes a heap.

Parameters:

  • first — Start of heap.
  • last — End of heap.
  • comp — Comparison functor to use.

This operation makes the elements in [first,last) into a heap. Comparisons are made using comp.

Definition at line 413 of file stl_heap.h.

Referenced by: std::__heap_select(), std::partial_sort_copy(), and std::priority_queue< _Tp, _Sequence, _Compare >::priority_queue().

🦋 std::make_heap — no _Compare 🦋

template<typename _RandomAccessIterator > void std::make_heap (_RandomAccessIterator __first, _RandomAccessIterator __last) [inline]

Construct a heap over a range. No custom comparator, just pure heap construction energy.

Parameters:

  • first — Start of heap.
  • last — End of heap.

This operation makes the elements in [first,last) into a heap.

Definition at line 373 of file stl_heap.h.

🦋 std::pop_heap — with _Compare 🦋

template<typename _RandomAccessIterator , typename _Compare > void std::pop_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp) [inline]

Pop an element off a heap, using your comparison functor. It's the exit scene for the top of the heap.

Parameters:

  • first — Start of heap.
  • last — End of heap.
  • comp — Comparison functor to use.

This operation pops the top of the heap. The elements first and last-1 are swapped and [first,last-1) is made into a heap. Comparisons are made using comp.

Definition at line 350 of file stl_heap.h.

Referenced by: std::priority_queue< _Tp, _Sequence, _Compare >::pop().

🦋 std::pop_heap — no _Compare 🦋

template<typename _RandomAccessIterator > void std::pop_heap (_RandomAccessIterator __first, _RandomAccessIterator __last) [inline]

Pop an element off a heap. No custom comparator, just the heap pop.

Parameters:

  • first — Start of heap.
  • last — End of heap.

This operation pops the top of the heap. The elements first and last-1 are swapped and [first,last-1) is made into a heap.

Definition at line 276 of file stl_heap.h.

🦋 std::push_heap — with _Compare 🦋

template<typename _RandomAccessIterator , typename _Compare > void std::push_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp) [inline]

Push an element onto a heap, using your comparison functor. Main character element enters the heap.

Parameters:

  • first — Start of heap.
  • last — End of heap + element.
  • comp — Comparison functor.

This operation pushes the element at last-1 onto the valid heap over the range [first,last-1). After completion, [first,last) is a valid heap. Compare operations are performed using comp.

Definition at line 203 of file stl_heap.h.

Referenced by: std::priority_queue< _Tp, _Sequence, _Compare >::push().

🦋 std::push_heap — no _Compare 🦋

template<typename _RandomAccessIterator > void std::push_heap (_RandomAccessIterator __first, _RandomAccessIterator __last) [inline]

Push an element onto a heap. No custom comparator, just the push.

Parameters:

  • first — Start of heap.
  • last — End of heap + element.

This operation pushes the element at last-1 onto the valid heap over the range [first,last-1). After completion, [first,last) is a valid heap.

Definition at line 154 of file stl_heap.h.

🦋 std::sort_heap — with _Compare 🦋

template<typename _RandomAccessIterator , typename _Compare > void std::sort_heap (_RandomAccessIterator __first, _RandomAccessIterator __last, _Compare __comp) [inline]

Sort a heap, using your comparison functor. The heap gets its life together and becomes sorted.

Parameters:

  • first — Start of heap.
  • last — End of heap.
  • comp — Comparison functor to use.

This operation sorts the valid heap in the range [first,last). Comparisons are made using comp.

Definition at line 481 of file stl_heap.h.

Referenced by: std::partial_sort(), and std::partial_sort_copy().

🦋 std::sort_heap — no _Compare 🦋

template<typename _RandomAccessIterator > void std::sort_heap (_RandomAccessIterator __first, _RandomAccessIterator __last) [inline]

Sort a heap. No custom comparator, just the sorting.

Parameters:

  • first — Start of heap.
  • last — End of heap.

This operation sorts the valid heap in the range [first,last).

Definition at line 452 of file stl_heap.h.

👑 Author 👑

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

xoxo, your Unix bestie 💅 — libstdc++, 21 Apr 2009, Heap Algorithms(3) 🎀

📦 where this page comes from