std::binary_search

来自cppreference.com
 
C++
 
算法库
受约束算法及范围上的算法 (C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作（在已划分范围上）
集合操作（在有序范围上）
归并操作（在有序范围上）
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
(C++20)
排列操作
C 库

数值运算
(C++11)                       
在未初始化内存上的操作
 
<tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num "> </tbody><tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num "> </tbody><tbody> </tbody>
在标头 <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 起)
See More

检查在已划分范围 [first, last) 中是否出现与 value 等价的元素。

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 必须使得 ForwardIt 类型的对象能在解引用后隐式转换到 Type1。类型 Type2 必须使得 T 类型的对象能隐式转换到 Type2。 ​

类型要求
-
ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator) 。
-
Compare 必须满足二元谓词 (BinaryPredicate) 。不要求满足 比较 (Compare) 。

返回值

找到等价于 value 的元素时返回 true，否则返回 false。

复杂度

给定 N 为 std::distance(first, last)：

1,2) 最多应用 log2(N)+O(1) 次 operator<(C++20 前)std::less{}(C++20 起) 进行比较。
3,4) 最多应用 log2(N)+O(1) 次比较函数 comp。

然而，如果 ForwardIt 不是老式随机访问迭代器 (LegacyRandomAccessIterator) ，那么迭代器自增次数与 N 成线性。

注解

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

可能的实现

另见 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()
{
    std::vector<int> haystack{1, 3, 4, 5, 9};
    std::vector<int> needles{1, 2, 3};
    
    for (const auto needle : needles)
    {
        std::cout << "正在搜索 " << needle << '\n';
        if (std::binary_search(haystack.begin(), haystack.end(), needle))
            std::cout << "找到了 " << needle << '\n';
        else
            std::cout << "没找到！\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
}

输出： 

正在搜索 1
找到了 1
正在搜索 2
没找到！
正在搜索 3
找到了 3

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 270 C++98 Compare 需要满足比较 (Compare) ，并且 T 需要是
可小于比较 (LessThanComparable) 的（要求严格弱序） 		只需要划分；容许异相比较
LWG 787 C++98 最多允许 log2(N)+2 次比较 改成 log2(N)+O(1) 次

参阅

 返回匹配特定键值的元素范围
(函数模板) [编辑]
返回首个不小于 给定值的元素的迭代器
(函数模板) [编辑]
返回首个大于 给定值的元素的迭代器
(函数模板) [编辑]
(C++20)
 判断元素是否在偏序范围中
(算法函数对象) [编辑]