Namespaces
Variants

std::max_element

出典: ja.cppreference.net
 
 
アルゴリズムライブラリ
制約付きアルゴリズムと範囲に関するアルゴリズム (C++20)
制約付きアルゴリズム、例えば ranges::copy、ranges::sort、...
ソートと関連操作
分割操作
(C++11)    

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


 
ヘッダ <algorithm>
template< class ForwardIt >
ForwardIt max_element( ForwardIt first, ForwardIt last );
で定義 (1) (C++17 から constexpr)
template< class ExecutionPolicy, class ForwardIt >
ForwardIt max_element( ExecutionPolicy&& policy,
                       ForwardIt first, ForwardIt last );
(2) (C++17 から)
template< class ForwardIt, class Compare >
ForwardIt max_element( ForwardIt first, ForwardIt last,
                       Compare comp );
(3) (C++17 から constexpr)
template< class ExecutionPolicy, class ForwardIt, class Compare >
ForwardIt max_element( ExecutionPolicy&& policy,
                       ForwardIt first, ForwardIt 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 は、型 ForwardIt のオブジェクトを間接参照し、その両方に暗黙的に変換できるようにする必要があります。

型要件
-
ForwardIt は LegacyForwardIterator の要件を満たす必要があります。

戻り値

範囲 [first, last) 内の最大の要素へのイテレータ。範囲内に最大の要素と同等の要素が複数ある場合、最初のそのような要素へのイテレータを返します。範囲が空の場合は last を返します。

計算量

N が std::distance(first, last) の場合:

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

例外

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

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

実装例

max_element (1)
template<class ForwardIt>
ForwardIt max_element(ForwardIt first, ForwardIt last)
{
    if (first == last)
        return last;
    
    ForwardIt largest = first;
    
    while (++first != last)
        if (*largest < *first)
            largest = first;
    
    return largest;
}
max_element (3)
template<class ForwardIt, class Compare>
ForwardIt max_element(ForwardIt first, ForwardIt last, Compare comp)
{
    if (first == last)
        return last;
    
    ForwardIt largest = first;
    
    while(++first != last)
        if (comp(*largest, *first))
            largest = first;
    
    return largest;
}

例

#include <algorithm>
#include <cmath>
#include <iostream>
#include <vector>

int main()
{
    std::vector<int> v{3, 1, -14, 1, 5, 9, -14, 9};
    std::vector<int>::iterator result;
    
    result = std::max_element(v.begin(), v.end());
    std::cout << "Max element found at index "
              << std::distance(v.begin(), result)
              << " has value " << *result << '\n';
    
    result = std::max_element(v.begin(), v.end(), [](int a, int b)
    {
        return std::abs(a) < std::abs(b);
    });
    std::cout << "Absolute max element found at index "
              << std::distance(v.begin(), result)
              << " has value " << *result << '\n';
}

出力:

Max element found at index 5 has value 9
Absolute max element found at index 2 has value -14

欠陥報告

以下の動作を変更する欠陥報告は、以前に公開された C++ 標準に遡って適用されました。

DR 適用先 公開時の動作 正しい動作
LWG 212 C++98 [first, last) が空の場合の戻り値が指定されていなかった この場合 last を返す
LWG 2150 C++98 最初の最小以外の要素へのイテレータが返されていた 戻り値を修正

関連項目

範囲内の最小の要素を返す
(関数テンプレート & アルゴリズム関数オブジェクト)
範囲内の最小と最大の要素を返す
(関数テンプレート & アルゴリズム関数オブジェクト)
与えられた値のうち大きい方を返す
(関数テンプレート & アルゴリズム関数オブジェクト)
範囲内の最大の要素を返す
(アルゴリズム関数オブジェクト)