# std::is_heap_until

> C++ Atlas: `cppatlas.com/w/cpp/algorithm/is_heap_until` | Source: https://en.cppreference.com/w/cpp/algorithm/is_heap_until | Domain: Algorithms | Standards: C++11, C++17, C++20

Examines the range [first, last) and finds the largest range beginning at first which is a heap.

## Official Specification Summary (cppreference)

```cpp
// Defined in header <algorithm>

template< class RandomIt >
RandomIt is_heap_until( RandomIt first, RandomIt last ); // (1) (since C++11) (constexpr since C++20)

template< class ExecutionPolicy, class RandomIt >
RandomIt is_heap_until( ExecutionPolicy&& policy,
                        RandomIt first, RandomIt last ); // (2) (since C++17)

template< class RandomIt, class Compare >
RandomIt is_heap_until( RandomIt first, RandomIt last, Compare comp ); // (3) (since C++11) (constexpr since C++20)

template< class ExecutionPolicy, class RandomIt, class Compare >
RandomIt is_heap_until( ExecutionPolicy&& policy,
                        RandomIt first, RandomIt last, Compare comp ); // (4) (since C++17)
```

Examines the range `[first,` `last)` and finds the largest range beginning at `first` which is a heap.

1) The heap property to be checked is with respect to `operator<` (until C++20) `std::less{}` (since C++20).

3) The heap property to be checked is with respect to `comp`.

2,4) Same as (1,3), but executed according to `policy`.

These overloads participate in overload resolution only if all following conditions are satisfied:

   `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)

### Parameters

- `first, last` - the range of elements to examine
- `policy` - the execution policy to use
- `comp` - comparison function object (i.e. an object that satisfies the requirements of *Compare*) which returns `true` if the first argument is *less* than the second.

  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.

**Type requirements**

- `RandomIt` must meet the requirements of *LegacyRandomAccessIterator*.
- `Compare` must meet the requirements of *Compare*.

### Return value

The last iterator `it` for which range `[first,` `it)` is a heap.

### Complexity

Given N as `std::distance(first, last)`:

1,2) O(N) comparisons using `operator<` (until C++20) `std::less{}` (since C++20).

3,4) O(N) applications of the comparison function `comp`.

### 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 other `ExecutionPolicy`, the behavior is implementation-defined.
- If the algorithm fails to allocate memory, `std::bad_alloc` is thrown.

### Example

```cpp
#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:

```text
all of v:  9 5 4 1 1 3 2 6
only heap: 9 5 4 1 1 3 2
```

### See also

- [`is_heap`](https://en.cppreference.com/w/cpp/algorithm/is_heap) (C++11): checks if the given range is a max heap (function template)
- [`make_heap`](https://en.cppreference.com/w/cpp/algorithm/make_heap): creates a max heap out of a range of elements (function template)
- [`push_heap`](https://en.cppreference.com/w/cpp/algorithm/push_heap): adds an element to a max heap (function template)
- [`pop_heap`](https://en.cppreference.com/w/cpp/algorithm/pop_heap): removes the largest element from a max heap (function template)
- [`sort_heap`](https://en.cppreference.com/w/cpp/algorithm/sort_heap): turns a max heap into a range of elements sorted in ascending order (function template)
- [`ranges::is_heap_until`](https://en.cppreference.com/w/cpp/algorithm/ranges/is_heap_until) (C++20): finds the largest subrange that is a max heap (algorithm function object)

---
Attribution: content from https://en.cppreference.com/w/cpp/algorithm/is_heap_until (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.