std::binary_search

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ(C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ(C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

ファイルシステムライブラリ(C++17)

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

技術仕様書

 

アルゴリズムライブラリ

制約付きアルゴリズムと範囲に対するアルゴリズム (C++20)
コンセプトとユーティリティ: std::sortable, std::projected, ...
制約付きアルゴリズム: std::ranges::copy, std::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)
非変更シーケンス操作
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal adjacent_find	findfind_iffind_if_not (C++11) find_end find_first_of	search search_n lexicographical_compare lexicographical_compare_three_way (C++20)
変更シーケンス操作
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) shift_leftshift_right (C++20)(C++20) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (C++17未満)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
未初期化記憶域の操作
uninitialized_copy uninitialized_move (C++17) uninitialized_fill	uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17)	uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17)
分割操作
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
ソート操作
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
二分探索操作
lower_bound	upper_bound	binary_search	equal_range
集合操作 (ソート済み範囲用)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
ヒープ操作
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
最小/最大演算
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
順列
is_permutation (C++11)	next_permutation	prev_permutation
数値演算
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)
C のライブラリ
qsort	bsearch

 

ヘッダ <algorithm> で定義
	(1)
template<class ForwardIt, class T > bool binary_search( ForwardIt first, ForwardIt last, const T& value );			(C++20未満)
template<class ForwardIt, class T > constexprbool binary_search( ForwardIt first, ForwardIt last, const T& value );			(C++20以上)
		(2)
template<class ForwardIt, class T, class Compare > bool binary_search( ForwardIt first, ForwardIt last, const T& value, Compare comp );				(C++20未満)
template<class ForwardIt, class T, class Compare > constexprbool binary_search( ForwardIt first, ForwardIt last, const T& value, Compare comp );				(C++20以上)

value と等しい要素が範囲 [first, last) 内に現れるかどうか調べます。

std::binary_search が成功するためには、範囲 [first, last) は少なくとも value に関して部分的に順序付けされていなければなりません。 つまり、以下の要件をすべて満たさなければなりません。

• element < value または comp(element, value) について分割されている (つまり、その式が true となるすべての要素が、その式が false となるすべての要素よりも前にある)。
• !(value < element) または !comp(value, element) について分割されている。
• すべての要素について、 element < value または comp(element, value) が true であれば、 !(value < element) または !comp(value, element) も true である。

完全にソートされた範囲はこれらの基準を満たします。

1つめのバージョンは要素を比較するために operator< を使用し、2つめのバージョンは指定された比較関数 comp を使用します。

引数

first, last	-	調べる要素の範囲
value	-	要素と比較する値
comp	-	第1引数が第2引数より小さい (つまり前に順序付けされる) 場合に ​true を返す二項述語。 述語関数のシグネチャは以下と同等なものであるべきです。  bool pred(const Type1 &a, const Type2 &b); シグネチャが const& を持つ必要はありませんが、関数は渡されたオブジェクトを変更してはなならず、値カテゴリに関わらず Type1 および Type2 型 (およびそれらの const 修飾された型) のすべての値を受理できなければなりません (そのため Type1 & は許されません。 また Type1 に対してムーブがコピーと同等でなければ Type1 も許されません(C++11以上))。 型 Type1 および Type2 は、 T 型のオブジェクトが Type1 と Type2 の両方に暗黙に変換可能であり、 ForwardIt 型のオブジェクトの逆参照が Type1 と Type2 の両方に暗黙に変換可能なものでなければなりません。 ​
型の要件
- ForwardIt は LegacyForwardIterator の要件を満たさなければなりません。
- Compare は BinaryPredicate の要件を満たさなければなりません。 Compare を満たす必要はありません。

戻り値

value と等しい要素が見つかれば true、そうでなければ false。

計算量

行われる比較の回数は first と last の距離の対数です (多くとも log
2(last - first) + O(1) 回の比較)。 しかし、 LegacyRandomAccessIterator でない場合、イテレータのインクリメント回数は線形になります。

実装例

1つめのバージョン
template<class ForwardIt, class T>bool binary_search(ForwardIt first, ForwardIt last, const T& value){ first =std::lower_bound(first, last, value);return(!(first == last)&&!(value <*first));}
2つめのバージョン
template<class ForwardIt, class T, 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)&&!(comp(value, *first)));}

例

Run this code

#include <iostream>#include <algorithm>#include <vector>   int main(){std::vector<int> haystack {1, 3, 4, 5, 9};std::vector<int> needles {1, 2, 3};   for(auto needle : needles){std::cout<<"Searching for "<< needle <<'\n';if(std::binary_search(haystack.begin(), haystack.end(), needle)){std::cout<<"Found "<< needle <<'\n';}else{std::cout<<"no dice!\n";}}}

出力:

Searching for 1 Found 1 Searching for 2 no dice! Searching for 3 Found 3

欠陥報告

以下の動作変更欠陥報告は以前に発行された C++ 標準に遡って適用されました。

DR	適用先	発行時の動作	正しい動作
LWG 270	C++98	Compare was required to be a strict weak ordering	only a partitioning is needed; heterogeneous comparisons permitted

関連項目

equal_range

特定のキーに一致する要素の範囲を返します (関数テンプレート)