std::is_heap

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

アルゴリズムライブラリ

制約付きアルゴリズムとRangeアルゴリズム (C++20)
制約付きアルゴリズム、例: ranges::copy, ranges::sort, ...
実行ポリシー (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
シーケンスを変更しない操作 一括操作 for_each for_each_n (C++17) 検索操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n シーケンスを変更する操作 コピー操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) スワップ操作 swap iter_swap swap_ranges 変換操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 削除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 順序変更操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17まで)(C++11) shift_leftshift_right (C++20)(C++20) サンプリング操作 sample (C++17)	ソートおよび関連操作 パーティション操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) ソート操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分探索操作 (パーティション化された範囲) lower_bound upper_bound equal_range binary_search 集合操作 (ソート済み範囲) includes set_union set_intersection set_difference set_symmetric_difference マージ操作 (ソート済み範囲) merge inplace_merge ヒープ操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 辞書順比較操作 lexicographical_compare lexicographical_compare_three_way (C++20) 順列操作 next_permutation prev_permutation is_permutation (C++11) Cライブラリ qsort bsearch
数値演算
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
未初期化メモリに対する操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

ヘッダー <algorithm> で定義
template< class RandomIt > bool is_heap( RandomIt first, RandomIt last );	(1)	(C++11以降) (C++20 以降 constexpr)
template< class ExecutionPolicy, class RandomIt > bool is_heap( ExecutionPolicy&& policy,               RandomIt first, RandomIt last );	(2)	(C++17以降)
template< class RandomIt, class Compare > bool is_heap( RandomIt first, RandomIt last, Compare comp );	(3)	(C++11以降) (C++20 以降 constexpr)
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<(C++20まで)std::less{}(C++20以降)に関するものである。

3) チェックされるヒーププロパティは、compに関するものである。

2,4) (1,3)と同じだが、policyに従って実行される。

これらのオーバーロードは、以下のすべての条件が満たされた場合にのみオーバーロード解決に参加する。

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が true である。	(C++20まで)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> は true です。	(C++20以降)

パラメーター

first, last	-	チェック対象要素の範囲を定義するイテレーターのペア
policy	-	使用する 実行ポリシー
comp	-	比較関数オブジェクト（すなわち、Compareの要件を満たすオブジェクト）。最初の引数が2番目の引数より小さい場合にtrueを返す。 比較関数のシグネチャは、以下と同等でなければならない。 bool cmp(const Type1& a, const Type2& b); シグネチャにconst&は必須ではないが、関数は渡されたオブジェクトを変更してはならず、値カテゴリに関係なく、Type1とType2のすべての型（おそらくconst）の値を受け入れられなければならない（したがって、Type1&は許可されない。また、Type1のムーブがコピーと同等でない限り、Type1も許可されない(C++11以降)）。 Type1とType2の型は、RandomIt型のオブジェクトが逆参照され、それらの両方に暗黙的に変換できるものでなければならない。
型要件
- RandomItはLegacyRandomAccessIteratorの要件を満たす必要がある。
- CompareはCompareの要件を満たす必要がある。

戻り値

対応する比較子に関して範囲がヒープである場合はtrueを返し、そうでない場合はfalseを返す。

計算量

std::distance(first, last) を \(\scriptsize N\)N とする

1,2) operator<(C++20まで)std::less{}(C++20以降)を使用した\(\scriptsize O(N)\)O(N)回の比較。

3,4) 比較関数compの\(\scriptsize O(N)\)O(N)回の適用。

例外

ExecutionPolicy というテンプレートパラメータを持つオーバーロードは、次のようにエラーを報告します。

• アルゴリズムの一部として呼び出された関数の実行が例外をスローし、ExecutionPolicy が 標準ポリシー のいずれかである場合、std::terminate が呼び出されます。その他の ExecutionPolicy の場合、動作は実装定義です。
• アルゴリズムがメモリの割り当てに失敗した場合、std::bad_alloc がスローされます。

例

このコードを実行

#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 << "initially, v:\n";
    for (const auto& i : v)
        std::cout << i << ' ';
    std::cout << '\n';
 
    if (!std::is_heap(v.begin(), v.end()))
    {
        std::cout << "making heap...\n";
        std::make_heap(v.begin(), v.end());
    }
 
    std::cout << "after make_heap, v:\n";
    for (auto t{1U}; const auto& i : v)
        std::cout << i << (std::has_single_bit(++t) ? " | " : " ");
    std::cout << '\n';
}

出力

initially, v:
3 1 4 1 5 9 2 6 5 3 5 8 9 7 9
making heap...
after make_heap, v:
9 | 6 9 | 5 5 9 7 | 1 1 3 5 8 3 4 2 |

関連項目

is_heap_until (C++11)	最大ヒープである最大のサブ範囲を見つける (関数テンプレート)
make_heap	要素の範囲から最大ヒープを作成する (関数テンプレート)
push_heap	最大ヒープに要素を追加する (関数テンプレート)
pop_heap	最大ヒープから最大の要素を削除する (関数テンプレート)
sort_heap	最大ヒープを昇順にソートされた要素の範囲に変換する (関数テンプレート)
ranges::is_heap (C++20)	与えられた範囲が最大ヒープであるかをチェックする (アルゴリズム関数オブジェクト)