std::find, std::find_if, std::find_if_not

 

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> で定義
	(1)
template< class InputIt, class T > InputIt find( InputIt first, InputIt last, const T& value );			(C++20 以降 constexpr) (C++26まで)
template< class InputIt, class T = typename std::iterator_traits                                        <InputIt>::value_type > constexpr InputIt find( InputIt first, InputIt last, const T& value );			(C++26以降)
		(2)
template< class ExecutionPolicy, class ForwardIt, class T > ForwardIt find( ExecutionPolicy&& policy,                 ForwardIt first, ForwardIt last, const T& value );				(C++17以降) (C++26まで)
template< class ExecutionPolicy,           class ForwardIt, class T = typename std::iterator_traits                                          <ForwardIt>::value_type > ForwardIt find( ExecutionPolicy&& policy,                 ForwardIt first, ForwardIt last, const T& value );				(C++26以降)
template< class InputIt, class UnaryPred > InputIt find_if( InputIt first, InputIt last, UnaryPred p );			(3)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class ForwardIt, class UnaryPred > ForwardIt find_if( ExecutionPolicy&& policy,                    ForwardIt first, ForwardIt last, UnaryPred p );			(4)	(C++17以降)
template< class InputIt, class UnaryPred > InputIt find_if_not( InputIt first, InputIt last, UnaryPred q );			(5)	(C++11以降) (C++20 以降 constexpr)
template< class ExecutionPolicy, class ForwardIt, class UnaryPred > ForwardIt find_if_not( ExecutionPolicy&& policy,                        ForwardIt first, ForwardIt last, UnaryPred q );			(6)	(C++17以降)

指定された条件を満たす範囲 [first, last) 内の最初の要素へのイテレータを返します (そのようなイテレータがない場合は last を返します)。

1) find は value と等しい要素を検索します (operator== を使用)。

3) find_if は述語 p が true を返す要素を検索します。

5) find_if_not は述語 q が false を返す要素を検索します。

2,4,6) (1,3,5) と同じですが、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	-	検査する要素の範囲を定義するイテレータのペア
value	-	要素と比較する値
policy	-	使用する 実行ポリシー
p	-	必要な要素に対して true を返す単項述語。 式 p(v) は、値カテゴリに関係なく、InputIt の値型である (const である可能性のある) VT 型のすべての引数 v に対して bool に変換可能でなければならず、v を変更してはなりません。したがって、VT& のパラメータ型は許可されません。また、VT の移動がコピーと同等でない限り、VT も許可されません(C++11以降)。​
q	-	必要な要素に対して false を返す単項述語。 式 q(v) は、値カテゴリに関係なく、InputIt の値型である (const である可能性のある) VT 型のすべての引数 v に対して bool に変換可能でなければならず、v を変更してはなりません。したがって、VT& のパラメータ型は許可されません。また、VT の移動がコピーと同等でない限り、VT も許可されません(C++11以降)。​
型要件
- InputIt は LegacyInputIterator の要件を満たす必要があります。
- ForwardIt は LegacyForwardIterator の要件を満たさなければなりません。
- UnaryPredicate は Predicate の要件を満たさなければなりません。

戻り値

以下の条件を満たす 範囲 [first, last) 内の最初のイテレータ it。そのようなイテレータがない場合は last。

1,2) *it == value が true。

3,4) p(*it) が true。

5,6) q(*it) が false。

計算量

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

1,2) operator== を使用して value との比較を最大 \(\scriptsize N\)N 回行います。

3,4) 述語 p の適用を最大 \(\scriptsize N\)N 回行います。

5,6) 述語 q の適用を最大 \(\scriptsize N\)N 回行います。

例外

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

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

可能な実装

find (1)
template<class InputIt, class T = typename std::iterator_traits<InputIt>::value_type> constexpr InputIt find(InputIt first, InputIt last, const T& value) { for (; first != last; ++first) if (*first == value) return first;   return last; }
find_if (3)
template<class InputIt, class UnaryPred> constexpr InputIt find_if(InputIt first, InputIt last, UnaryPred p) { for (; first != last; ++first) if (p(*first)) return first;   return last; }
find_if_not (5)
template<class InputIt, class UnaryPred> constexpr InputIt find_if_not(InputIt first, InputIt last, UnaryPred q) { for (; first != last; ++first) if (!q(*first)) return first;   return last; }

注釈

C++11 が利用できない場合、std::find_if_not と同等の機能は、否定された述語を持つ std::find_if を使用することです。

template<class InputIt, class UnaryPred> InputIt find_if_not(InputIt first, InputIt last, UnaryPred q) { return std::find_if(first, last, std::not1(q)); }

機能テストマクロ	値	規格	機能
__cpp_lib_algorithm_default_value_type	202403	(C++26)	アルゴリズム (1,2) のためのリスト初期化

例

次の例は、与えられたシーケンス内の数値を検索します。

このコードを実行

#include <algorithm>
#include <array>
#include <cassert>
#include <complex>
#include <initializer_list>
#include <iostream>
#include <vector>
 
bool is_even(int i)
{
    return i % 2 == 0;
}
 
void example_contains()
{
    const auto haystack = {1, 2, 3, 4};
 
    for (const int needle : {3, 5})
        if (std::find(haystack.begin(), haystack.end(), needle) == haystack.end())
            std::cout << "haystack does not contain " << needle << '\n';
        else
            std::cout << "haystack contains " << needle << '\n';
}
 
void example_predicate()
{
    for (const auto& haystack : {std::array{3, 1, 4}, {1, 3, 5}})
    {
        const auto it = std::find_if(haystack.begin(), haystack.end(), is_even);
        if (it != haystack.end())
            std::cout << "haystack contains an even number " << *it << '\n';
        else
            std::cout << "haystack does not contain even numbers\n";
    }
}
 
void example_list_init()
{
    std::vector<std::complex<double>> haystack{{4.0, 2.0}};
#ifdef __cpp_lib_algorithm_default_value_type
    // T gets deduced making list-initialization possible
    const auto it = std::find(haystack.begin(), haystack.end(), {4.0, 2.0});
#else
    const auto it = std::find(haystack.begin(), haystack.end(), std::complex{4.0, 2.0});
#endif
    assert(it == haystack.begin());  
}
 
int main()
{
    example_contains();
    example_predicate();
    example_list_init();
}

出力

haystack contains 3
haystack does not contain 5
haystack contains an even number 4
haystack does not contain even numbers

欠陥レポート

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

DR	適用対象	公開された動作	正しい動作
LWG 283	C++98	T は EqualityComparable であることが求められていましたが、 InputIt の値型は T ではない可能性があります	要件が削除されました

関連項目

adjacent_find	等しい（または指定された述語を満たす）最初の2つの隣接する項目を見つける (関数テンプレート)
find_end	特定の範囲内で最後の要素のシーケンスを見つける (関数テンプレート)
find_first_of	要素の集合のうちいずれか1つを検索する (関数テンプレート)
mismatch	2つの範囲が異なる最初の位置を見つける (関数テンプレート)
search	要素の範囲の最初の出現を検索する (関数テンプレート)
ranges::findranges::find_ifranges::find_if_not (C++20)(C++20)(C++20)	特定の基準を満たす最初の要素を見つける (アルゴリズム関数オブジェクト)