| Defined in header <algorithm>
|
||
| Call signature |
||
| template< std::random_access_iterator I, std::sentinel_for<I> S, class Proj = std::identity, std::indirect_strict_weak_order < std::projected<I, Proj>> Comp = ranges::less > constexpr I is_heap_until( I first, S last, Comp comp = {}, Proj proj = {} ); |
(1) | (since C++20) |
| template< ranges::random_access_range R, class Proj = std::identity, std::indirect_strict_weak_order <std::projected <ranges::iterator_t<R>, Proj>> Comp = ranges::less > constexpr ranges::borrowed_iterator_t<R> is_heap_until( R&& r, Comp comp = {}, Proj proj = {} ); |
(2) | (since C++20) |
Within the specified range, finds the longest range which starting from the beginning of the specified range and represents a heap with respect to comp and proj.
[first, last).r.The function-like entities described on this page are algorithm function objects (informally known as niebloids), that is:
- Explicit template argument lists cannot be specified when calling any of them.
- None of them are visible to argument-dependent lookup.
- When any of them are found by normal unqualified lookup as the name to the left of the function-call operator, argument-dependent lookup is inhibited.
Parameters
| first, last | - | the range of elements to examine |
| r | - | the range of elements to examine |
| pred | - | predicate to apply to the projected elements |
| proj | - | projection to apply to the elements |
Return value
The last iterator iter in the specified range for which:
[first, iter) is a heap with respect to comp and proj.Complexity
O(N) applications of comp and proj, where N is:
ranges::distance(first, last)ranges::distance(r)Possible implementation
|
Example
The example renders a given vector as a (balanced) Binary tree.
#include <algorithm>
#include <cmath>
#include <iostream>
#include <iterator>
#include <vector>
void out(const auto& what, int n = 1)
{
while (n-- > 0)
std::cout << what;
}
void draw_bin_tree(auto first, auto last)
{
auto bails = [](int n, int w)
{
auto b = [](int w) { out("┌"), out("─", w), out("┴"), out("─", w), out("┐"); };
n /= 2;
if (!n)
return;
for (out(' ', w); n-- > 0;)
b(w), out(' ', w + w + 1);
out('\n');
};
auto data = [](int n, int w, auto& first, auto last)
{
for (out(' ', w); n-- > 0 && first != last; ++first)
out(*first), out(' ', w + w + 1);
out('\n');
};
auto tier = [&](int t, int m, auto& first, auto last)
{
const int n{1 << t};
const int w{(1 << (m - t - 1)) - 1};
bails(n, w), data(n, w, first, last);
};
const auto size{std::ranges::distance(first, last)};
const int m{static_cast<int>(std::ceil(std::log2(1 + size)))};
for (int i{}; i != m; ++i)
tier(i, m, first, last);
}
int main()
{
std::vector<int> v{3, 1, 4, 1, 5, 9};
std::ranges::make_heap(v);
// probably mess up the heap
v.push_back(2);
v.push_back(6);
out("v after make_heap and push_back:\n");
draw_bin_tree(v.begin(), v.end());
out("the max-heap prefix of v:\n");
const auto heap_end = std::ranges::is_heap_until(v);
draw_bin_tree(v.begin(), heap_end);
}
v after make_heap and push_back:
9
┌───┴───┐
5 4
┌─┴─┐ ┌─┴─┐
1 1 3 2
┌┴┐ ┌┴┐ ┌┴┐ ┌┴┐
6
the max-heap prefix of v:
9
┌─┴─┐
5 4
┌┴┐ ┌┴┐
1 1 3 2See also
| (C++20) |
checks if the given range is a max heap (algorithm function object) |
| (C++20) |
creates a max heap out of a range of elements (algorithm function object) |
| (C++20) |
adds an element to a max heap (algorithm function object) |
| (C++20) |
removes the largest element from a max heap (algorithm function object) |
| (C++20) |
turns a max heap into a range of elements sorted in ascending order (algorithm function object) |
| (C++11) |
finds the largest subrange that is a max heap (function template) |
Content from this page on cppreference.com, licensed under CC-BY-SA 3.0 and GFDL. Modified: restyled, site navigation removed, code windows added. Offline snapshot of 9 February 2025.