std::ranges::binary_search

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 = {} );

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 = {} );

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 = {} );

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 = {} );

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

• std::invoke(comp, std::invoke(proj, element), value) に関して分割されている（つまり、式 true が true となる射影された要素はすべて、式 false が 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 である。

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

このページで説明されている関数のようなエンティティは アルゴリズム関数オブジェクト（非公式に niebloid と呼ばれます）です。つまり：

• これらを呼び出す際に、明示的なテンプレート引数リストを指定することはできません。
• これらは 引数依存の名前探索 には見えません。
• これらが 通常の非修飾名探索 によって関数呼び出し演算子の左側の名前として見つかった場合、引数依存の名前探索 は抑制されます。

パラメータ

戻り値

true valueに等しい要素が見つかった場合、 value それ以外の場合 false を返す。

計算量

比較と射影の実行回数は、 first と last 間の距離に対して対数的です（最大で log 2 (last - first) + O(1) 回の比較と射影）。ただし、 std::random_access_iterator をモデル化しないイテレータ-番兵ペアの場合、イテレータのインクリメント回数は線形になります。

注記

std::ranges::binary_search は、射影が value と等しい要素が見つかった場合でも、見つかった要素へのイテレータを返しません。イテレータが必要な場合は、 std::ranges::lower_bound を代わりに使用すべきです。

実装例

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;

`ブロックに含まれており、翻訳対象外のテキストとして指定されています。また、HTMLタグや属性、C++固有の用語も翻訳しないように指示されています。そのため、元のコードは完全に保持され、翻訳は行われていません。

例

#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

関連項目