std::is_heap

在标头 `<algorithm>` 定义
	(1)
template< class RandomIt > bool is_heap( RandomIt first, RandomIt last );			(C++11 起) (C++20 前)
template< class RandomIt > constexpr bool is_heap( RandomIt first, RandomIt last );			(C++20 起)
template< class ExecutionPolicy, class RandomIt > bool is_heap( ExecutionPolicy&& policy, RandomIt first, RandomIt last );		(2)	(C++17 起)
		(3)
template< class RandomIt, class Compare > bool is_heap( RandomIt first, RandomIt last, Compare comp );				(C++11 起) (C++20 前)
template< class RandomIt, class Compare > constexpr bool is_heap( RandomIt first, RandomIt last, Compare comp );				(C++20 起)
template< class ExecutionPolicy, class RandomIt, class Compare > bool is_heap( ExecutionPolicy&& policy, RandomIt first, RandomIt last, Compare comp );			(4)	(C++17 起)

检查范围 [first, last) 是否为堆。

1) 要检查的堆属性是关于 operator< 的。

3) 要检查的堆属性是关于 comp 的。

2,4) 同 (1,3)，但按照 policy 执行。这些重载只有在

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>	(C++20 前)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>	(C++20 起)

是 true 时才会参与重载决议。

参数

first, last	-	要检验的范围
policy	-	所用的执行策略。细节见执行策略。
comp	-	比较函数对象（即满足比较 (Compare) 要求的对象），如果首个参数小于第二个，那么返回 true。比较函数的签名应等价于如下： bool cmp(const Type1 &a, const Type2 &b); 虽然签名不必有 const &，函数也不能修改传递给它的对象，而且必须接受（可有 const 限定的）类型 `Type1` 与 `Type2` 的值，与值类别无关（从而不允许 Type1 &，也不允许 Type1，除非 `Type1` 的移动等价于复制 (C++11 起)）。类型 Type1 与 Type2 必须使得 RandomIt 类型的对象能在解引用后隐式转换到这两个类型。
类型要求
- `RandomIt` 必须符合老式随机访问迭代器 (LegacyRandomAccessIterator) 的要求。
- `Compare` 必须符合比较 (Compare) 的要求。

返回值

如果范围是关于对应比较器的堆就返回 true，否则返回 false。

复杂度

与 std::distance(first, last) 成线性。

异常

拥有名为 ExecutionPolicy 的模板形参的重载按下列方式报告错误：

如果作为算法一部分调用的函数的执行抛出异常，且 ExecutionPolicy 是标准策略之一，那么调用 std::terminate。对于任何其他 ExecutionPolicy，行为由实现定义。
如果算法无法分配内存，那么抛出 std::bad_alloc。

注解

关于 comp 的堆（最大堆）是拥有下列属性的随机访问范围 [first, last)：

给定 $\scriptsize N$ $N$ 为 last - first，对于满足 $\scriptsize 0 < i < N$ $0 < i < N$ 的所有整数 i，bool(comp(first[(i - 1) / 2], first[i])) 都是 false。
可以通过 std::push_heap 在 $\scriptsize \mathcal{O}(\log N)$ $𝓞(log N)$ 时间内添加新元素。
可以通过 std::pop_heap 在 $\scriptsize \mathcal{O}(\log N)$ $𝓞(log N)$ 时间内移除 *first。

示例

运行此代码

#include <algorithm>
#include <bit>
#include <iostream>
#include <vector>
 
int main()
{
    std::vector<int> v{3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 8, 9, 7, 9};
 
    std::cout << "一开始，v：\n";
    for (auto i : v)
        std::cout << i << ' ';
    std::cout << '\n';
 
    if (!std::is_heap(v.begin(), v.end()))
    {
        std::cout << "正在制作堆。。。\n";
        std::make_heap(v.begin(), v.end());
    }
 
    std::cout << "make_heap 后，v：\n";
    for (auto t{1U}; auto i : v)
        std::cout << i << (std::has_single_bit(++t) ? " | " : " ");
    std::cout << '\n';
}

输出：

一开始，v：
3 1 4 1 5 9 2 6 5 3 5 8 9 7 9
正在制作堆。。。
make_heap 后，v：
9 | 6 9 | 5 5 9 7 | 1 1 3 5 8 3 4 2 |

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
LWG 2166	C++11	对堆的要求与最大堆的定义不够接近	改进要求

参阅

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

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库

std::is_heap

参数

返回值

复杂度

异常

注解

示例

缺陷报告

参阅

导航