std::search_n

 

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 ForwardIt, class Size, class T > ForwardIt search_n( ForwardIt first, ForwardIt last,                     Size count, const T& value );			(C++20 以降 constexpr) (C++26まで)
template< class ForwardIt, class Size,           class T = typename std::iterator_traits                         <ForwardIt>::value_type > constexpr ForwardIt search_n( ForwardIt first, ForwardIt last,                               Size count, const T& value );			(C++26以降)
		(2)
template< class ExecutionPolicy,           class ForwardIt, class Size, class T > ForwardIt search_n( ExecutionPolicy&& policy,                     ForwardIt first, ForwardIt last,                     Size count, const T& value );				(C++17以降) (C++26まで)
template< class ExecutionPolicy,           class ForwardIt, class Size,           class T = typename std::iterator_traits                         <ForwardIt>::value_type > ForwardIt search_n( ExecutionPolicy&& policy,                     ForwardIt first, ForwardIt last,                     Size count, const T& value );				(C++26以降)
			(3)
template< class ForwardIt, class Size, class T, class BinaryPred > ForwardIt search_n( ForwardIt first, ForwardIt last,                     Size count, const T& value, BinaryPred p );					(C++20 以降 constexpr) (C++26まで)
template< class ForwardIt, class Size,           class T = typename std::iterator_traits                         <ForwardIt>::value_type,           class BinaryPred > constexpr ForwardIt search_n( ForwardIt first, ForwardIt last,                     Size count, const T& value, BinaryPred p );					(C++26以降)
				(4)
template< class ExecutionPolicy, class ForwardIt, class Size,           class T, class BinaryPred > ForwardIt search_n( ExecutionPolicy&& policy,                     ForwardIt first, ForwardIt last,                     Size count, const T& value, BinaryPred p );						(C++17以降) (C++26まで)
template< class ExecutionPolicy, class ForwardIt, class Size,           class T = typename std::iterator_traits                         <ForwardIt>::value_type,           class BinaryPred > ForwardIt search_n( ExecutionPolicy&& policy,                     ForwardIt first, ForwardIt last,                     Size count, const T& value, BinaryPred p );						(C++26以降)

範囲 [first, last) 内で、指定された value と等しい要素が count 個連続する最初のシーケンスを検索します。

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

パラメータ

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

戻り値

count が正の場合、範囲 [first, last) 内で見つかった最初のシーケンスの先頭を指すイテレータを返します。シーケンス内の各イテレータ it は、次の条件を満たす必要があります。

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

3,4) p(*it, value) != false が true

そのようなシーケンスが見つからない場合、last が返されます。

count がゼロまたは負の場合、first が返されます。

計算量

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

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

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

例外

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

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

可能な実装

search_n (1)
template<class ForwardIt, class Size, class T = typename std::iterator_traits<ForwardIt>::value_type> ForwardIt search_n(ForwardIt first, ForwardIt last, Size count, const T& value) { if (count <= 0) return first;   for (; first != last; ++first) { if (!(*first == value)) continue;   ForwardIt candidate = first;   for (Size cur_count = 1; true; ++cur_count) { if (cur_count >= count) return candidate; // success   ++first; if (first == last) return last; // exhausted the list   if (!(*first == value)) break; // too few in a row } } return last; }
search_n (3)
template<class ForwardIt, class Size, class T = typename std::iterator_traits<ForwardIt>::value_type, class BinaryPred> ForwardIt search_n(ForwardIt first, ForwardIt last, Size count, const T& value, BinaryPred p) { if (count <= 0) return first;   for (; first != last; ++first) { if (!p(*first, value)) continue;   ForwardIt candidate = first;   for (Size cur_count = 1; true; ++cur_count) { if (cur_count >= count) return candidate; // success   ++first; if (first == last) return last; // exhausted the list   if (!p(*first, value)) break; // too few in a row } } return last; }

注釈

機能テストマクロ	値	規格	機能
__cpp_lib_algorithm_default_value_type	202403	(C++26)	リスト初期化（バージョン 1-4）

例

このコードを実行

#include <algorithm>
#include <cassert>
#include <complex>
#include <iostream>
#include <iterator>
#include <vector>
 
template<class Container, class Size, class T>
constexpr bool consecutive_values(const Container& c, Size count, const T& v)
{
    return std::search_n(std::begin(c), std::end(c), count, v) != std::end(c);
}
 
int main()
{
    constexpr char sequence[] = ".0_0.000.0_0.";
 
    static_assert(consecutive_values(sequence, 3, '0'));
 
    for (int n : {4, 3, 2})
        std::cout << std::boolalpha
                  << "Has " << n << " consecutive zeros: "
                  << consecutive_values(sequence, n, '0') << '\n';
 
    std::vector<std::complex<double>> nums{{4, 2}, {4, 2}, {1, 3}};
    #ifdef __cpp_lib_algorithm_default_value_type
        auto it = std::search_n(nums.cbegin(), nums.cend(), 2, {4, 2});
    #else
        auto it = std::search_n(nums.cbegin(), nums.cend(), 2, std::complex<double>{4, 2});
    #endif
    assert(it == nums.begin());
}

出力

Has 4 consecutive zeros: false
Has 3 consecutive zeros: true
Has 2 consecutive zeros: true

不具合報告

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

DR	適用対象	公開された動作	正しい動作
LWG 283	C++98	T は EqualityComparable であることが求められていましたが、 InputIt の値型が常に T ではない	要件が削除されました
LWG 426	C++98	計算量の最大値が N·count であった count が負の場合、負になる	上限は ​0​ count が非正の場合
LWG 714	C++98	count > 0 の場合、計算量の最大値は N·count であったが、 最悪の場合、比較/操作の回数は常に N	上限を変更した この場合、上限を N にした
LWG 2150	C++98	「シーケンス出現」の条件が正しくなかった	修正済み

関連項目

find_end	特定の範囲内で最後の要素のシーケンスを見つける (関数テンプレート)
findfind_iffind_if_not (C++11)	特定の基準を満たす最初の要素を見つける (関数テンプレート)
search	要素の範囲の最初の出現を検索する (関数テンプレート)
ranges::search_n (C++20)	範囲内である要素が連続して出現する最初の箇所を検索する (アルゴリズム関数オブジェクト)