std::search

 

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 ForwardIt1, class ForwardIt2 > ForwardIt1 search( ForwardIt1 first, ForwardIt1 last,                    ForwardIt2 s_first, ForwardIt2 s_last );	(1)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class ForwardIt1, class ForwardIt2 > ForwardIt1 search( ExecutionPolicy&& policy,                    ForwardIt1 first, ForwardIt1 last,                    ForwardIt2 s_first, ForwardIt2 s_last );	(2)	(C++17以降)
template< class ForwardIt1, class ForwardIt2, class BinaryPred > ForwardIt1 search( ForwardIt1 first, ForwardIt1 last,                    ForwardIt2 s_first, ForwardIt2 s_last,                    BinaryPred p );	(3)	(C++20 以降 constexpr)
template< class ExecutionPolicy,           class ForwardIt1, class ForwardIt2, class BinaryPred > ForwardIt1 search( ExecutionPolicy&& policy,                    ForwardIt1 first, ForwardIt1 last,                    ForwardIt2 s_first, ForwardIt2 s_last,                    BinaryPred p );	(4)	(C++17以降)
template< class ForwardIt, class Searcher > ForwardIt search( ForwardIt first, ForwardIt last,                   const Searcher& searcher );	(5)	(C++17以降) (C++20 以降 constexpr)

1-4) 範囲 [first, last) 内で、範囲 [s_first, s_last) の要素シーケンスの最初の出現箇所を検索します。

1) 要素は operator== を使用して比較されます。

3) 要素は、指定された二項述語 p を使用して比較されます。

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以降)

5) 範囲 [first, last) 内で、searcher のコンストラクタで指定されたパターンを検索します。

標準ライブラリは以下の searcher を提供します。 default_searcher (C++17) 標準C++ライブラリの探索アルゴリズム実装 (クラステンプレート) boyer_moore_searcher (C++17) ボイヤー・ムーア法探索アルゴリズム実装 (クラステンプレート) boyer_moore_horspool_searcher (C++17) ボイヤー・ムーア・ホースプール法探索アルゴリズム実装 (クラステンプレート)

(C++17以降)

パラメータ

first, last	-	検査する要素の範囲を定義するイテレータのペア
s_first, s_last	-	検索対象の要素の範囲を定義するイテレータのペア。
policy	-	使用する 実行ポリシー
searcher	-	検索アルゴリズムと検索対象のパターンをカプセル化する searcher。
p	-	要素が等しいと見なされる場合に true を返す二項述語。 述語関数のシグネチャは、以下と同等である必要がある。  bool pred(const Type1 &a, const Type2 &b); シグネチャは const & を持つ必要はないが、関数は渡されたオブジェクトを変更してはならず、値カテゴリに関わらず、(おそらく const の) Type1 と Type2 のすべての値を受け入れられる必要がある (したがって、Type1 & は許可されない。また、Type1 の場合、ムーブがコピーと同等でない限り、Type1 も許可されない。(C++11以降))。 Type1 および Type2 の型は、ForwardIt1 および ForwardIt2 のオブジェクトがそれぞれ Type1 および Type2 に間接参照され、暗黙的に変換可能である必要があります。
型要件
- ForwardIt1, ForwardIt2 は LegacyForwardIterator の要件を満たさなければなりません。
- BinaryPred は BinaryPredicate の要件を満たす必要がある。

戻り値

1-4) 範囲 [first, last) 内で、シーケンス [s_first, s_last) の最初の出現箇所の先頭を指すイテレータ。そのような出現箇所が見つからなかった場合は、last が返されます。

[s_first, s_last) が空の場合、first が返されます。

5) searcher(first, last).first。

計算量

1-4) \(\scriptsize N\)N を std::distance(first, last)、\(\scriptsize S\)S を std::distance(s_first, s_last) とすると、

1,2) \(\scriptsize N\cdot S\)N·S 回以下の operator== による比較。

3,4) 述語 p の \(\scriptsize N\cdot S\)N·S 回以下の適用。

5) searcher に依存します。

例外

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

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

実装例

search (1)
template<class ForwardIt1, class ForwardIt2> constexpr //< since C++20 ForwardIt1 search(ForwardIt1 first, ForwardIt1 last, ForwardIt2 s_first, ForwardIt2 s_last) { while (true) { ForwardIt1 it = first; for (ForwardIt2 s_it = s_first; ; ++it, ++s_it) { if (s_it == s_last) return first; if (it == last) return last; if (!(*it == *s_it)) break; } ++first; } }
search (3)
template<class ForwardIt1, class ForwardIt2, class BinaryPred> constexpr //< since C++20 ForwardIt1 search(ForwardIt1 first, ForwardIt1 last, ForwardIt2 s_first, ForwardIt2 s_last, BinaryPred p) { while (true) { ForwardIt1 it = first; for (ForwardIt2 s_it = s_first; ; ++it, ++s_it) { if (s_it == s_last) return first; if (it == last) return last; if (!p(*it, *s_it)) break; } ++first; } }

例

このコードを実行

#include <algorithm>
#include <cassert>
#include <functional>
#include <iomanip>
#include <iostream>
#include <iterator>
#include <string_view>
#include <vector>
 
using namespace std::literals;
 
bool contains(const auto& cont, std::string_view s)
{
    // str.find() (or str.contains(), since C++23) can be used as well
    return std::search(cont.begin(), cont.end(), s.begin(), s.end()) != cont.end();
}
 
int main()
{
    const auto str{"why waste time learning, when ignorance is instantaneous?"sv};
    assert(contains(str, "learning"));
    assert(not contains(str, "lemming"));
 
    const std::vector vec(str.begin(), str.end());
    assert(contains(vec, "learning"));
    assert(not contains(vec, "leaning"));
 
    // The C++17 overload with searchers demo:
    constexpr auto quote
    {
        "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed "
        "do eiusmod tempor incididunt ut labore et dolore magna aliqua"sv
    };
 
    for (const auto word : {"pisci"sv, "Pisci"sv})
    {
        std::cout << "The string " << std::quoted(word) << ' ';
        const std::boyer_moore_searcher searcher(word.begin(), word.end());
        const auto it = std::search(quote.begin(), quote.end(), searcher);
        if (it == quote.end())
            std::cout << "not found\n";
        else
            std::cout << "found at offset " << std::distance(quote.begin(), it) << '\n';
    }
}

出力

The string "pisci" found at offset 43
The string "Pisci" not found

不具合報告

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

DR	適用対象	公開された動作	正しい動作
LWG 1205	C++98	[s_first, s_last) が空の場合の戻り値が不明瞭でした。	この場合、first が返されます。
LWG 1338	C++98	LWG issue 1205 の解決策が誤って適用され、 出現箇所が見つからなかった場合に first が返されるようになっていました。	この場合、last が返されます。
LWG 2150	C++98	「シーケンス出現」の条件が正しくなかった	修正済み

関連項目

find_end	特定の範囲内で最後の要素のシーケンスを見つける (関数テンプレート)
includes	あるシーケンスが別のシーケンスの部分シーケンスである場合に true を返す (関数テンプレート)
equal	2つの要素の集合が同じかどうかを判断する (関数テンプレート)
findfind_iffind_if_not (C++11)	特定の基準を満たす最初の要素を見つける (関数テンプレート)
lexicographical_compare	ある範囲が別の範囲より辞書順で小さい場合に true を返す (関数テンプレート)
mismatch	2つの範囲が異なる最初の位置を見つける (関数テンプレート)
search_n	範囲内である要素が連続して出現する最初の箇所を検索する (関数テンプレート)
default_searcher (C++17)	標準C++ライブラリの探索アルゴリズム実装 (クラステンプレート)
boyer_moore_searcher (C++17)	ボイヤー・ムーア法探索アルゴリズム実装 (クラステンプレート)
boyer_moore_horspool_searcher (C++17)	ボイヤー・ムーア・ホースプール法探索アルゴリズム実装 (クラステンプレート)
ranges::search (C++20)	要素の範囲の最初の出現を検索する (アルゴリズム関数オブジェクト)