std::ranges::lower_bound

ヘッダ `<algorithm>`
で定義
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 I lower_bound( I first, S last, const T& value, Comp comp = {}, Proj proj = {} );	呼び出しシグネチャ	(1) (C++20 以上)
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 I lower_bound( I first, S last, const T& value, Comp comp = {}, Proj proj = {} );	呼び出しシグネチャ		(C++26 まで)
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 ranges::borrowed_iterator_t<R> lower_bound( R&& r, const T& value, Comp comp = {}, Proj proj = {} );	(C++26 以上)	(2) (C++20 以上)
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 ranges::borrowed_iterator_t<R> lower_bound( R&& r, const T& value, Comp comp = {}, Proj proj = {} );	(C++26 以上)		(C++26 まで)

(C++26 以上)1)[first, last) 範囲 内の、「valueより小さくない」（すなわち以上である）最初の要素を指すイテレータを返します。そのような要素が見つからない場合は last を返します。範囲 [first, last) は式 std::invoke(comp, std::invoke(proj, element), value) に関して分割されていなければなりません。すなわち、式が true となるすべての要素は、式が false となるすべての要素よりも前に位置しなければなりません。完全にソートされた範囲はこの条件を満たします。

2) (1) と同じですが、ソース範囲として r を使用します。これは、ranges::begin(r) を first として、ranges::end(r) を last として使用するのと同じです。

このページに記述されている関数のようなエンティティは アルゴリズム関数オブジェクト (非公式には niebloids として知られています) であり、以下の特性を持ちます:

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

パラメータ

first, last	-	部分的に順序付けられた要素の範囲を定義するイテレータ-番兵ペア
r	-	調査対象の部分的に順序付けられた範囲
value	-	投影された要素と比較する値
comp	-	投影された要素に適用する比較述語
proj	-	要素に適用する投影

戻り値

value 以上である最初の要素を指すイテレータ、またはそのような要素が見つからない場合は last を返す。

計算量

比較および投影の適用回数は、 first と last の間の距離に対して対数的です（最大 $log 2 (last - first) + O(1)$ 回の比較と投影の適用）。しかし、 random_access_iterator をモデル化しないイテレータの場合、イテレータのインクリメント回数は線形になります。

注記

完全にソートされた範囲（あるいはより一般的に、射影後に value に関して部分的に順序付けられた範囲）において、 std::ranges::lower_bound は二分探索アルゴリズムを実装します。したがって、 std::ranges::binary_search はこれを用いて実装することが可能です。

機能テストマクロ	値	標準	機能
`__cpp_lib_algorithm_default_value_type`	`202403`	(C++26)	リスト初期化アルゴリズム用 ( 1,2 )

実装例

struct lower_bound_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 I operator()(I first, S last, const T& value,
                           Comp comp = {}, Proj proj = {}) const
    {
        I it;
        std::iter_difference_t<I> count, step;
        count = std::ranges::distance(first, last);
        while (count > 0)
        {
            it = first;
            step = count / 2;
            ranges::advance(it, step, last);
            if (comp(std::invoke(proj, *it), value))
            {
                first = ++it;
                count -= step + 1;
            }
            else
                count = step;
        }
        return first;
    }
    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 ranges::borrowed_iterator_t<R>
        operator()(R&& r, const T& value, Comp comp = {}, Proj proj = {}) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), value,
                       std::ref(comp), std::ref(proj));
    }
};
inline constexpr lower_bound_fn lower_bound;

例

このコードを実行

#include <algorithm>
#include <cassert>
#include <complex>
#include <iostream>
#include <iterator>
#include <vector>
namespace ranges = std::ranges;
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 I binary_find(I first, S last, const T& value, Comp comp = {}, Proj proj = {})
{
    first = ranges::lower_bound(first, last, value, comp, proj);
    return first != last && !comp(value, proj(*first)) ? first : last;
}
int main()
{
    std::vector data{1, 2, 2, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 5};
    //                                 ^^^^^^^^^^
    auto lower = ranges::lower_bound(data, 4);
    auto upper = ranges::upper_bound(data, 4);
    std::cout << "found a range [" << ranges::distance(data.cbegin(), lower)
              << ", " << ranges::distance(data.cbegin(), upper) << ") = { ";
    ranges::copy(lower, upper, std::ostream_iterator<int>(std::cout, " "));
    std::cout << "}\n";
    // 古典的な二分探索、値が存在する場合のみ返す
    data = {1, 2, 4, 8, 16};
    //               ^
    auto it = binary_find(data.cbegin(), data.cend(), 8); // '5' は end() を返す
    if (it != data.cend())
        std::cout << *it << " found at index " << ranges::distance(data.cbegin(), it);
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 0}, {2, 2}, {2, 1}, {3, 0}};
    auto cmpz = [](CD x, CD y) { return x.real() < y.real(); };
    #ifdef __cpp_lib_algorithm_default_value_type
        auto it2 = ranges::lower_bound(nums, {2, 0}, cmpz);
    #else
        auto it2 = ranges::lower_bound(nums, CD{2, 0}, cmpz);
    #endif
    assert((*it2 == CD{2, 2}));
}

出力:

found a range [6, 10) = { 4 4 4 4 }
8 found at index 3

コンパイラサポート
フリースタンディングとホスト環境
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Ranges ライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日時ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様
シンボルインデックス
外部ライブラリ

ranges::equal_range (C++20)	二分探索を使用して、指定された値と一致する要素の範囲を検索する (アルゴリズム関数オブジェクト)
ranges::partition (C++20)	要素の範囲を2つのグループに分割する (アルゴリズム関数オブジェクト)
ranges::partition_point (C++20)	分割された範囲の分割点を特定する (アルゴリズム関数オブジェクト)
ranges::upper_bound (C++20)	二分探索を使用して、指定された値より大きい最初の要素を検索する (アルゴリズム関数オブジェクト)
lower_bound	二分探索を使用して、指定された値より小さくない最初の要素を検索する (関数テンプレート)

ja.cppreference.net

Namespaces

Variants

std::ranges::lower_bound

目次

パラメータ

戻り値

計算量

注記

実装例

例

関連項目