std::binary_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> で定義
	(1)
template< class ForwardIt, class T > bool binary_search( ForwardIt first, ForwardIt last,                     const T& value );			(C++20 以降 constexpr) (C++26まで)
template< class ForwardIt, class T = typename std::iterator_traits                                          <ForwardIt>::value_type > constexpr bool binary_search( ForwardIt first, ForwardIt last,                               const T& value );			(C++26以降)
		(2)
template< class ForwardIt, class T, class Compare > bool binary_search( ForwardIt first, ForwardIt last,                     const T& value, Compare comp );				(C++20 以降 constexpr) (C++26まで)
template< class ForwardIt, class T = typename std::iterator_traits                                          <ForwardIt>::value_type,           class Compare > constexpr bool binary_search( ForwardIt first, ForwardIt last,                               const T& value, Compare comp );				(C++26以降)

要素 value と等価な要素が、区分された範囲 [first, last) 内に存在するかどうかをチェックします。

1) 等価性は operator< を用いてチェックされます。

[first, last) 内のいずれかのイテレータ iter について、!bool(*iter < value) && !bool(value < *iter) が true の場合、true を返します。それ以外の場合は false を返します。 次のいずれかの条件が満たされる場合、動作は未定義です。 [first, last) の任意の要素 elem について、bool(elem < value) は !bool(value < elem) を含意しません。 [first, last) の要素 elem は、式 bool(elem < value) および !bool(value < elem) に関して 区分 されていません。	(C++20まで)
std::binary_search(first, last, value, std::less{}) と同等です。	(C++20以降)

2) 等価性は comp を用いてチェックされます。

[first, last) 内のいずれかのイテレータ iter について、!bool(comp(*iter, value)) && !bool(comp(value, *iter)) が true の場合、true を返します。それ以外の場合は false を返します。

以下のいずれかの条件が満たされている場合、動作は未定義です。

• [first, last) の任意の要素 elem について、bool(comp(elem, value)) は !bool(comp(value, elem)) を含意しません。
• [first, last) の要素 elem は、式 bool(comp(elem, value)) および !bool(comp(value, elem)) に関して 区分 されていません。

Parameters

first, last	-	調査する要素の分割された範囲を定義するイテレータのペア
value	-	要素と比較する値
comp	-	第一引数が第二引数より前に順序付けられる場合に `true` を返す二項述語。 述語関数のシグネチャは、以下と同等である必要がある。  bool pred(const Type1 &a, const Type2 &b); シグネチャは const & を持つ必要はないが、関数は渡されたオブジェクトを変更してはならず、値カテゴリに関わらず、(おそらく const の) Type1 と Type2 のすべての値を受け入れられる必要がある (したがって、Type1 & は許可されない。また、Type1 の場合、ムーブがコピーと同等でない限り、Type1 も許可されない。(C++11以降))。 Type1 および Type2 の型は、T 型のオブジェクトが Type1 および Type2 の両方に暗黙的に変換可能であり、かつ ForwardIt 型のオブジェクトを間接参照してから Type1 および Type2 の両方に暗黙的に変換可能である必要があります。
型要件
- ForwardIt は LegacyForwardIterator の要件を満たさなければなりません。
- `Compare` は BinaryPredicate の要件を満たす必要があります。 Compare を満たす必要はありません。

Return value

true 要素 value と等価な要素が見つかった場合、false それ以外の場合。

Complexity

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

1) \(\scriptsize \log_{2}(N)+O(1)\)log2(N)+O(1) 回以下の比較が value に対して行われます（operator<(until C++20)std::less{}(since C++20) を使用）。

2) \(\scriptsize \log_{2}(N)+O(1)\)log2(N)+O(1) 回以下のコンパレータ comp の適用。

ただし、ForwardIt が LegacyRandomAccessIterator でない場合、イテレータのインクリメント回数は \(\scriptsize N\)N に対して線形になります。

Notes

std::binary_search は [first, last) が区分されていることのみを要求しますが、このアルゴリズムは通常、[first, last) がソートされている場合に使用され、これにより任意の value に対して二分探索が有効になります。

std::binary_search は等価な要素が存在するかどうかのみをチェックします。その要素（存在する場合）へのイテレータを取得するには、代わりに std::lower_bound を使用する必要があります。

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

Possible implementation

libstdc++ および libc++ の実装も参照してください。

binary_search (1)
template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type> bool binary_search(ForwardIt first, ForwardIt last, const T& value) { return std::binary_search(first, last, value, std::less{}); }
binary_search (2)
template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type, class Compare> bool binary_search(ForwardIt first, ForwardIt last, const T& value, Compare comp) { first = std::lower_bound(first, last, value, comp); return (!(first == last) and !(comp(value, *first))); }

Example

このコードを実行

#include <algorithm>
#include <cassert>
#include <complex>
#include <iostream>
#include <vector>
 
int main()
{
    const auto haystack = {1, 3, 4, 5, 9};
 
    for (const auto needle : {1, 2, 3})
    {
        std::cout << "Searching for " << needle << '\n';
        if (std::binary_search(haystack.begin(), haystack.end(), needle))
            std::cout << "Found " << needle << '\n';
        else
            std::cout << "Not found!\n";
    }
 
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 1}, {2, 3}, {4, 2}, {4, 3}};
    auto cmpz = [](CD x, CD y){ return abs(x) < abs(y); };
    #ifdef __cpp_lib_algorithm_default_value_type
        assert(std::binary_search(nums.cbegin(), nums.cend(), {4, 2}, cmpz));
    #else
        assert(std::binary_search(nums.cbegin(), nums.cend(), CD{4, 2}, cmpz));
    #endif
}

出力

Searching for 1
Found 1
Searching for 2
Not found!
Searching for 3
Found 3

Defect reports

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

DR	適用対象	公開された動作	正しい動作
LWG 270	C++98	Compare は Compare を満たす必要があり、`T` は LessThanComparable (厳密弱順序が必要) である必要がありました。	分割のみが必要。 異種比較が許可される。
LWG 787	C++98	最大 \(\scriptsize \log_{2}(N)+2\)log2(N)+2 回の比較が許可されていました。	\(\scriptsize \log_{2}(N)+O(1)\)log2(N)+O(1) に修正されました。

See also

equal_range	特定のキーに一致する要素の範囲を返す (関数テンプレート)
lower_bound	与えられた値より小さくない最初の要素へのイテレータを返す (関数テンプレート)
upper_bound	特定の値より大きい最初の要素へのイテレータを返す (関数テンプレート)
ranges::binary_search (C++20)	部分的に順序付けられた範囲に要素が存在するかどうかを判断する (アルゴリズム関数オブジェクト)