std::is_heap_until
<algorithm>
RandomIt is_heap_until( RandomIt first, RandomIt last );
(constexpr since C++20)
RandomIt is_heap_until( ExecutionPolicy&& policy,
RandomIt is_heap_until( RandomIt first, RandomIt last, Compare comp );
(constexpr since C++20)
RandomIt is_heap_until( ExecutionPolicy&& policy,
Examines the range [
first,
last)
and finds the largest range beginning at first which is a heap.
std::is_execution_policy_v <std::decay_t <ExecutionPolicy>> is true.
(until C++20)std::is_execution_policy_v <std::remove_cvref_t <ExecutionPolicy>> is true.
(since C++20)[edit] Parameters
The signature of the comparison function should be equivalent to the following:
bool cmp(const Type1& a, const Type2& b);
While the signature does not need to have const&, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const) Type1
and Type2
regardless of value category (thus, Type1& is not allowed, nor is Type1 unless for Type1
a move is equivalent to a copy(since C++11)).
The types Type1 and Type2 must be such that an object of type RandomIt can be dereferenced and then implicitly converted to both of them.
RandomIt
must meet the requirements of LegacyRandomAccessIterator.
Compare
must meet the requirements of Compare.
[edit] Return value
The last iterator it for which range [
first,
it)
is a heap.
[edit] Complexity
Given \(\scriptsize N\)N as std::distance (first, last):
[edit] Exceptions
The overloads with a template parameter named ExecutionPolicy
report errors as follows:
- If execution of a function invoked as part of the algorithm throws an exception and
ExecutionPolicy
is one of the standard policies, std::terminate is called. For any otherExecutionPolicy
, the behavior is implementation-defined. - If the algorithm fails to allocate memory, std::bad_alloc is thrown.
[edit] Example
#include <algorithm> #include <iostream> #include <vector> int main() { std::vector <int> v{3, 1, 4, 1, 5, 9}; std::make_heap (v.begin(), v.end()); // probably mess up the heap v.push_back(2); v.push_back(6); auto heap_end = std::is_heap_until(v.begin(), v.end()); std::cout << "all of v: "; for (const auto& i : v) std::cout << i << ' '; std::cout << '\n'; std::cout << "only heap: "; for (auto i = v.begin(); i != heap_end; ++i) std::cout << *i << ' '; std::cout << '\n'; }
Output:
all of v: 9 5 4 1 1 3 2 6 only heap: 9 5 4 1 1 3 2