std::ranges::binary_search

在头文件 `<algorithm>` 中定义
调用签名
	(1)
template< std::forward_iterator I, std::sentinel_for<I> S, class T, class Proj = std::identity, std::indirect_strict_weak_order <const T*, std::projected<I, Proj>> Comp = ranges::less > constexpr bool binary_search( I first, S last, const T& value, Comp comp = {}, Proj proj = {} );			(自 C++20 起) (直到 C++26)
template< std::forward_iterator I, std::sentinel_for<I> S, class Proj = std::identity, class T = std::projected_value_t<I, Proj>, std::indirect_strict_weak_order <const T*, std::projected<I, Proj>> Comp = ranges::less > constexpr bool binary_search( I first, S last, const T& value, Comp comp = {}, Proj proj = {} );			(自 C++26 起)
		(2)
template< ranges::forward_range R, class T, class Proj = std::identity, std::indirect_strict_weak_order <const T*, std::projected<ranges::iterator_t<R>, Proj>> Comp = ranges::less > constexpr bool binary_search( R&& r, const T& value, Comp comp = {}, Proj proj = {} );				(自 C++20 起) (直到 C++26)
template< ranges::forward_range R, class Proj = std::identity, class T = std::projected_value_t<ranges::iterator_t<R>, Proj>, std::indirect_strict_weak_order <const T*, std::projected<ranges::iterator_t<R>, Proj>> Comp = ranges::less > constexpr bool binary_search( R&& r, const T& value, Comp comp = {}, Proj proj = {} );				(自 C++26 起)

1) 检查投影后的元素是否与 value 相同，并出现在范围 [first, last) 中。

2) 与 (1) 相同，但使用 r 作为源范围，就像使用 ranges::begin(r) 作为 first 以及 ranges::end(r) 作为 last。

为了使 ranges::binary_search 成功，范围 [first, last) 必须至少部分地相对于 value 有序，也就是说必须满足以下所有要求：

相对于 std::invoke(comp, std::invoke(proj, element), value) 进行分区（也就是说，所有表达式为 true 的投影元素位于所有表达式为 false 的元素之前）。
相对于 !std::invoke(comp, value, std::invoke(proj, element)) 进行分区。
对于所有元素，如果 std::invoke(comp, std::invoke(proj, element), value) 为 true，那么 !std::invoke(comp, value, std::invoke(proj, element)) 也为 true。

一个完全排序的范围满足这些条件。

本页面描述的函数式实体是 niebloids，即

调用它们时，不能指定显式模板参数列表。
它们对依赖于参数的查找不可见。
当它们通过普通无限定查找作为函数调用运算符左侧的名称被找到时，依赖于参数的查找被抑制。

在实践中，它们可以被实现为函数对象，或者使用特殊的编译器扩展。

[edit] 参数

first, last	-	要检查的元素范围
r	-	要检查的元素范围
value	-	用于比较元素的值
comp	-	要应用于投影元素的比较函数
proj	-	要应用于元素的投影

[edit] 返回值

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

[edit] 复杂度

执行的比较和投影次数是对 first 和 last 之间距离的对数（最多 $log 2 (last - first) + O(1)$ 次比较和投影）。但是，对于不模拟 std::random_access_iterator 的迭代器-哨兵对，迭代器增量次数是线性的。

[edit] 说明

std::ranges::binary_search 在找到投影等于 value 的元素时，不会返回指向该元素的迭代器。如果需要迭代器，则应该使用 std::ranges::lower_bound。

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

[edit] 可能的实现

struct binary_search_fn
{
    template<std::forward_iterator I, std::sentinel_for<I> S,
             class Proj = std::identity, class T = std::projected_value_t<I, Proj>,
             std::indirect_strict_weak_order
                 <const T*, std::projected<I, Proj>> Comp = ranges::less>
    constexpr bool operator()(I first, S last, const T& value,
                              Comp comp = {}, Proj proj = {}) const
    {
        auto x = ranges::lower_bound(first, last, value, comp, proj);
        return (!(x == last) && !(std::invoke(comp, value, std::invoke(proj, *x))));
    }
 
    template<ranges::forward_range R, class Proj = std::identity,
             class T = std::projected_value_t<ranges::iterator_t<R>, Proj>,
             std::indirect_strict_weak_order
                 <const T*, std::projected<ranges::iterator_t<R>,
                                           Proj>> Comp = ranges::less>
    constexpr bool operator()(R&& r, const T& value, Comp comp = {}, Proj proj = {}) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), value,
                       std::move(comp), std::move(proj));
    }
};
 
inline constexpr binary_search_fn binary_search;

[edit] 示例

运行此代码

#include <algorithm>
#include <cassert>
#include <complex>
#include <iostream>
#include <ranges>
#include <vector>
 
int main()
{
    constexpr static auto haystack = {1, 3, 4, 5, 9};
    static_assert(std::ranges::is_sorted(haystack));
 
    for (const int needle : std::views::iota(1)
                          | std::views::take(3))
    {
        std::cout << "Searching for " << needle << ": ";
        std::ranges::binary_search(haystack, needle)
            ? std::cout << "found " << needle << '\n'
            : 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::ranges::binary_search(nums, {4, 2}, cmpz));
    #else
        assert(std::ranges::binary_search(nums, CD{4, 2}, cmpz));
    #endif
}

输出

Searching for 1: found 1
Searching for 2: no dice!
Searching for 3: found 3

[edit] 另请参见

ranges::equal_range (C++20)	返回与特定键匹配的元素范围 (niebloid)[edit]
ranges::lower_bound (C++20)	返回指向第一个不小于给定值的元素的迭代器 (niebloid)[edit]
ranges::upper_bound (C++20)	返回指向第一个大于特定值的元素的迭代器 (niebloid)[edit]
ranges::containsranges::contains_subrange (C++23)(C++23)	检查范围是否包含给定的元素或子范围 (niebloid)[edit]
binary_search	确定部分有序范围中是否存在元素 (函数模板) [edit]

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

cppreference.com

命名空间

变体

视图

操作