std::binary_search

定義於標頭檔案 `<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)) 進行劃分。

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。

[edit] 返回值

如果找到與 value 等價的元素，則返回 true，否則返回 false。

[edit] 複雜度

給定 $\scriptsize N$ $N$ 為 std::distance(first, last)

1) 最多

log 2 (N)+O(1)

次使用 operator<(C++20 前)std::less{}(C++20 起) 與 value 進行比較。

2) 最多

log 2 (N)+O(1)

次應用比較器 comp。

但是，如果 ForwardIt 不是 LegacyRandomAccessIterator，則迭代器增量的次數與 $\scriptsize N$ $N$ 成線性關係。

[edit] 注意

儘管 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)

[edit] 可能的實現

另請參閱 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)));
}

[edit] 示例

執行此程式碼

#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

[edit] 缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 270	C++98	`Compare` 需要滿足比較，且 `T` 需要是可小於比較的（需要嚴格弱序）	只需要分割槽；允許異構比較
LWG 787	C++98	最多允許 $\scriptsize \log_{2}(N)+2$ $log 2 (N)+2$ 次比較	更正為 $\scriptsize \log_{2}(N)+O(1)$ $log 2 (N)+O(1)$

[edit] 另請參閱

equal_range	返回與特定鍵匹配的元素範圍 (函式模板) [編輯]
lower_bound	返回一個指向第一個不小於給定值的元素的迭代器 (函式模板) [編輯]
upper_bound	返回一個指向第一個大於某個值的元素的迭代器 (函式模板) [編輯]
ranges::binary_search (C++20)	判斷一個元素是否存在於部分有序的範圍中 (演算法函式物件)[編輯]

編譯器支援
自由（freestanding）與宿主（hosted）
語言
標準庫
標準庫標頭檔案
具名要求
特性測試宏 (C++20)
語言支援庫
概念庫 (C++20)
診斷庫
記憶體管理庫
超程式設計庫 (C++11)
通用工具庫
容器庫
迭代器庫
範圍庫 (C++20)
演算法庫
字串庫
文字處理庫
數值庫
日期和時間庫
輸入/輸出庫
檔案系統庫 (C++17)
併發支援庫 (C++11)
執行控制庫 (C++26)
技術規範
符號索引
外部庫

cppreference.com

名稱空間

變體

檢視

操作