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<

如果 !bool(*iter < value) && !bool(value < *iter) 对 [first, last) 中的某个迭代器 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

如果 !bool(comp(*iter, value)) && !bool(comp(value, *iter)) 对 [first, last) 中的某个迭代器 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的要求。

[编辑] 返回值

如果找到与 value 等效的元素，则返回 true，否则返回 false。

[编辑] 复杂度

假设 $\scriptsize N$ $N$ 是 std::distance(first, last)

1) 使用 operator<(直到 C++20)std::less{}(自 C++20 起)，最多进行

log 2 (N)+O(1)

次与 value 的比较。

2) 最多进行

log 2 (N)+O(1)

次比较器 comp 的应用。

但是，如果 ForwardIt 不是LegacyRandomAccessIterator，则迭代器增量的次数与 $\scriptsize N$ $N$ 成线性关系。

[编辑] 备注

虽然 std::binary_search 只要求 [first, last) 被分区，但此算法通常用于 [first, last) 被排序的情况，以便二分查找对任何 value 都有效。

std::binary_search 仅检查是否存在等效元素。要获取指向该元素的迭代器（如果存在），应改用 std::lower_bound。

特性测试宏	值	Std	特性
`__cpp_lib_algorithm_default_value_type`	202403	(C++26)	算法的列表初始化 (1,2)

[编辑] 可能的实现

另请参阅 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)));
}

[编辑] 示例

运行此代码

#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 << "No dice!\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
no dice!
Searching for 3
Found 3

[编辑] 缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。

DR	应用于	发布的行为	正确行为
LWG 270	C++98	`Compare` 需要满足Compare，`T` 需要是LessThanComparable（需要严格弱排序）	只需要分区；允许异构比较
LWG 787	C++98	最多允许 $\scriptsize \log_{2}(N)+2$ $log 2 (N)+2$ 次比较	更正为 $\scriptsize \log_{2}(N)+O(1)$ $log 2 (N)+O(1)$

[编辑] 参见

equal_range	返回与特定键匹配的元素范围 (函数模板) [编辑]
lower_bound	返回指向第一个不小于给定值的元素的迭代器 (函数模板) [编辑]
upper_bound	返回指向第一个大于某个值的元素的迭代器 (函数模板) [编辑]
ranges::binary_search (C++20)	确定部分有序范围内是否存在元素 (niebloid)[编辑]

编译器支持
独立和托管
语言
标准库
标准库头文件
命名需求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用程序库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

cppreference.com

命名空间

变体

视图

操作