# std::ranges::is_heap_until

< cpp‎ | algorithm‎ | ranges

定义于头文件 `<algorithm>` |  |
调用签名 |  |
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) | (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) | (C++20 起)

检验范围 `[first, last)` 并寻找始于 `first` 且为最大堆的最大范围。

1) 用给定的二元比较函数 `comp` 和投影对象 `proj` 比较元素。
2) 同 (1) ，但以 `r` 为范围，如同以 ranges::begin(r) 为 `first` 并以 ranges::end(r) 为 `last` 。

此页面上描述的仿函数实体是 niebloid ，即：

- 调用它们中的任何一者时不可指定显式模板实参。
- 它们无一对实参依赖查找可见。
- 在通常无限定查找寻找函数调用运算符左侧的名称找到它们之一时，它禁止实参依赖查找。

实际上，它们能以函数对象，或以某些特殊编译器扩展实现。

### 参数

first, last | - | 要检验的元素范围
r | - | 要检验的元素范围
pred | - | 应用到投影后元素的谓词
proj | - | 应用到元素的投影

### 返回值

始于 `first` 并为最大堆的最大范围的上界。即尾迭代器 `it` ，使得范围 `[first, it)` 相对于 `comp` 与 `proj` 为最大堆。

### 复杂度

与 `first` 和 `last` 间的距离成线性。

### 注解

最大堆是按照比较器 `comp` 与投影 `proj` 排列的元素范围 `[f, l)` ，拥有下列属性：

  - 令 N == l - f ，对于所有 `0 < i < N` ， p == f[(i - 1) / 2] 和 q == f[i] ，表达式 std::invoke(comp, std::invoke(proj, p), std::invoke(proj, q)) 求值为 false 。
  - 能用 ranges::push_heap() 在 \(\scriptsize \mathcal{O}(\log N)\)𝓞(log N) 时间内添加新元素。
  - 能用 ranges::pop_heap() 在 \(\scriptsize \mathcal{O}(\log N)\)𝓞(log N) 时间内移除首元素。

### 可能的实现

    struct is_heap_until_fn {
        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
        operator()( I first, S last, Comp comp = {}, Proj proj = {} ) const {
            std::iter_difference_t<I> n {ranges::distance(first, last)}, dad {0}, son {1};
            for (; son != n; ++son) {
                if (std::invoke(comp, std::invoke(proj, *(first + dad)),
                                      std::invoke(proj, *(first + son)))) {
                    return first + son;
                } else if ((son % 2) == 0) {
                    ++dad;
                }
            }
            return first + n;
        }

        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>
        operator()( R&& r, Comp comp = {}, Proj proj = {} ) const {
            return (*this)(ranges::begin(r), ranges::end(r), std::move(comp), std::move(proj));
        }
    };

    inline constexpr is_heap_until_fn is_heap_until{};

### 示例

此示例将给定的 vector 重置为（平衡）二叉树。

    #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);

    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);
    }

    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); }
    }

输出：

    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 2

### 参阅

ranges::is_heap (C++20) | 检查给定范围是否为最大堆 (niebloid)
ranges::make_heap (C++20) | 从一个元素范围创建出一个最大堆 (niebloid)
ranges::push_heap (C++20) | 将一个元素加入到一个最大堆 (niebloid)
ranges::pop_heap (C++20) | 从最大堆中移除最大元素 (niebloid)
ranges::sort_heap (C++20) | 将一个最大堆变成一个按升序排序的元素范围 (niebloid)
is_heap_until (C++11) | 查找能成为最大堆的最大子范围 (函数模板)