Namespaces
Variants

    std::is_heap

    ja.cppreference.net より
     
    C++
    コンパイラサポート
    フリースタンディングとホステッド
    言語
    標準ライブラリ
    標準ライブラリヘッダ
    名前付き要件
    機能テストマクロ (C++20)
    言語サポートライブラリ
    コンセプトライブラリ (C++20)
    診断ライブラリ
    メモリ管理ライブラリ
    メタプログラミングライブラリ (C++11)
    汎用ユーティリティライブラリ
    コンテナライブラリ
    イテレータライブラリ
    レンジライブラリ (C++20)
    アルゴリズムライブラリ
    文字列ライブラリ
    テキスト処理ライブラリ
    数値ライブラリ
    日付と時刻ライブラリ
    入出力ライブラリ
    ファイルシステムライブラリ (C++17)
    並行処理サポートライブラリ (C++11)
    実行制御ライブラリ (C++26)
    技術仕様書
    シンボルインデックス
    外部ライブラリ
     
    アルゴリズムライブラリ
    制約付きアルゴリズムとレンジ上のアルゴリズム (C++20)
    制約付きアルゴリズム、例： ranges::copy、 ranges::sort、 ...
    ソートと関連操作
    分割操作
    (C++11)    
    (C++11)

    ソート操作
    二分探索操作
    (分割された範囲に対して)
    集合操作 (ソート済み範囲に対して)
    マージ操作 (ソート済み範囲に対して)
    ヒープ操作
    最小値/最大値操作
    (C++11)
    (C++17)
    辞書順比較操作
    (C++20)
    順列操作


     
    ヘッダ <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 に従って実行される。
    これらのオーバーロードは、次の式の値が true である場合にのみオーバーロード解決に参加する。

    std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>

    		(C++20まで)

    std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>>

    		(C++20以降)

    パラメータ

    first, last - チェック対象の要素の範囲を定義するイテレータのペア
    policy - 使用する実行ポリシー
    comp - 比較関数オブジェクト（つまり、 Compare の要件を満たすオブジェクト）。最初の引数が2番目の引数より 小さい 場合に 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 それ以外の場合。

    計算量

    与えられた N を std:: distance ( first, last ) として：

    1,2) O(N) 回の比較を operator < (C++20まで) std:: less { } (C++20以降) を使用して行います。
    3,4) O(N) 回の比較関数 comp の適用。

    例外

    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 |

    関連項目

    (C++11)
    		 最大ヒープである最大の部分範囲を探す
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    		要素の範囲から最大ヒープを作成する
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    		要素を最大ヒープに追加する
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    		最大ヒープから最大要素を削除する
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    		最大ヒープを昇順にソートされた要素の範囲に変換する
    (関数テンプレート & アルゴリズム関数オブジェクト)
    (C++20)
    (C++20)
    		 指定された範囲が最大ヒープかどうかを確認する
    (アルゴリズム関数オブジェクト)