std::upper_bound

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

アルゴリズムライブラリ

制約付きアルゴリズムとRangeアルゴリズム (C++20)
制約付きアルゴリズム、例: ranges::copy, ranges::sort, ...
実行ポリシー (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
シーケンスを変更しない操作 一括操作 for_each for_each_n (C++17) 検索操作 all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n シーケンスを変更する操作 コピー操作 copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) スワップ操作 swap iter_swap swap_ranges 変換操作 replacereplace_if transform replace_copyreplace_copy_if 生成操作 fill fill_n generate generate_n 削除操作 removeremove_if unique remove_copyremove_copy_if unique_copy 順序変更操作 reverse reverse_copy rotate rotate_copy random_shuffleshuffle (C++17まで)(C++11) shift_leftshift_right (C++20)(C++20) サンプリング操作 sample (C++17)	ソートおよび関連操作 パーティション操作 partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) ソート操作 sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element 二分探索操作 (パーティション化された範囲) lower_bound upper_bound equal_range binary_search 集合操作 (ソート済み範囲) includes set_union set_intersection set_difference set_symmetric_difference マージ操作 (ソート済み範囲) merge inplace_merge ヒープ操作 push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) 最小/最大操作 max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) 辞書順比較操作 lexicographical_compare lexicographical_compare_three_way (C++20) 順列操作 next_permutation prev_permutation is_permutation (C++11) Cライブラリ qsort bsearch
数値演算
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
未初期化メモリに対する操作
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

ヘッダー <algorithm> で定義
	(1)
template< class ForwardIt, class T > ForwardIt upper_bound( 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 ForwardIt upper_bound( ForwardIt first, ForwardIt last,                                  const T& value );			(C++26以降)
		(2)
template< class ForwardIt, class T, class Compare > ForwardIt upper_bound( 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 ForwardIt upper_bound( ForwardIt first, ForwardIt last,                                  const T& value, Compare comp );				(C++26以降)

分割された範囲 [first, last) で、value より後に順序付けられる最初の要素を検索します。

1) 順序は operator< によって決定されます。

[first, last) 内で、bool(value < *iter) が true となる最初のイテレータ iter を返します。そのような iter が存在しない場合は last を返します。 [first, last) の要素 elem が、式 bool(value < elem) に関して 分割されていない場合、動作は未定義です。	(C++20まで)
std::upper_bound(first, last, value, std::less{}) と同等です。	(C++20以降)

2) 順序は comp によって決定されます。

[first, last) 内で、bool(comp(value, *iter)) が true となる最初のイテレータ iter を返します。そのような iter が存在しない場合は last を返します。

[first, last) の要素 elem が、式 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` 型は、`T` 型のオブジェクトが `Type1` に暗黙的に変換可能でなければなりません。`Type2` 型は、`ForwardIt` 型のオブジェクトを逆参照し、その後 `Type2` に暗黙的に変換可能でなければなりません。
型要件
- ForwardIt は LegacyForwardIterator の要件を満たさなければなりません。
- `Compare` は BinaryPredicate の要件を満たす必要があります。 Compare を満たす必要はありません。

戻り値

[first, last) の範囲内で、value より後に順序付けられる最初の要素へのイテレータ。そのような要素が見つからない場合は last。

計算量

std::distance(first, last) を \(\scriptsize N\)N とする

1) \(\scriptsize \log_{2}(N)+O(1)\)log2(N)+O(1) 回以下の比較が value に対して行われます（operator<(until C++20)std::less{}(since C++20) を使用）。

2) \(\scriptsize \log_{2}(N)+O(1)\)log2(N)+O(1) 回以下のコンパレータ comp の適用。

ただし、`ForwardIt` が LegacyRandomAccessIterator でない場合、イテレータのインクリメント回数は \(\scriptsize N\)N に対して線形になります。特に、std::map、std::multimap、std::set、および std::multiset のイテレータはランダムアクセスではないため、これらのメンバ関数 upper_bound を優先すべきです。

実装例

libstdc++ および libc++ の実装を参照してください。

upper_bound (1)
template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type> ForwardIt upper_bound(ForwardIt first, ForwardIt last, const T& value) { return std::upper_bound(first, last, value, std::less{}); }
upper_bound (2)
template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type, class Compare> ForwardIt upper_bound(ForwardIt first, ForwardIt last, const T& value, Compare comp) { ForwardIt it; typename std::iterator_traits<ForwardIt>::difference_type count, step; count = std::distance(first, last);   while (count > 0) { it = first; step = count / 2; std::advance(it, step);   if (!comp(value, *it)) { first = ++it; count -= step + 1; } else count = step; }   return first; }

注記

std::upper_bound は [first, last) が分割されていることのみを要求しますが、このアルゴリズムは通常、[first, last) がソートされている場合に、任意の value に対して二分探索が有効になるように使用されます。

[first, last) 内の任意のイテレータ iter に対して、std::upper_bound は value < *iter および comp(value, *iter) が有効であることを要求しますが、std::lower_bound は代わりに *iter < value および comp(*iter, value) が有効であることを要求します。

機能テストマクロ	値	規格	機能
__cpp_lib_algorithm_default_value_type	202403	(C++26)	アルゴリズム (1,2) のためのリスト初期化

例

このコードを実行

#include <algorithm>
#include <cassert>
#include <complex>
#include <iostream>
#include <vector>
 
struct PriceInfo { double price; };
 
int main()
{
    const std::vector<int> data{1, 2, 4, 5, 5, 6};
 
    for (int i = 0; i < 7; ++i)
    {
        // Search first element that is greater than i
        auto upper = std::upper_bound(data.begin(), data.end(), i);
 
        std::cout << i << " < ";
        upper != data.end()
            ? std::cout << *upper << " at index " << std::distance(data.begin(), upper)
            : std::cout << "not found";
        std::cout << '\n';
    }
 
    std::vector<PriceInfo> prices{{100.0}, {101.5}, {102.5}, {102.5}, {107.3}};
 
    for (double to_find : {102.5, 110.2})
    {
        auto prc_info = std::upper_bound(prices.begin(), prices.end(), to_find,
            [](double value, const PriceInfo& info)
            {
                return value < info.price;
            });
 
        prc_info != prices.end()
            ? std::cout << prc_info->price << " at index " << prc_info - prices.begin()
            : std::cout << to_find << " not found";
        std::cout << '\n';
    }
 
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 0}, {2, 2}, {2, 1}, {3, 0}, {3, 1}};
    auto cmpz = [](CD x, CD y) { return x.real() < y.real(); };
    #ifdef __cpp_lib_algorithm_default_value_type
        auto it = std::upper_bound(nums.cbegin(), nums.cend(), {2, 0}, cmpz);
    #else
        auto it = std::upper_bound(nums.cbegin(), nums.cend(), CD{2, 0}, cmpz);
    #endif
    assert((*it == CD{3, 0}));
}

出力

0 < 1 at index 0
1 < 2 at index 1
2 < 4 at index 2
3 < 4 at index 2
4 < 5 at index 3
5 < 6 at index 5
6 < not found 
107.3 at index 4
110.2 not found

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 270	C++98	Compare は Compare を満たす必要があり、`T` は LessThanComparable (厳密弱順序が必要) である必要がありました。	分割のみが必要。 異種比較が許可される。
LWG 384	C++98	\(\scriptsize \log(N)+1\)log2(N)+1 回以下の比較が許可されていました。	\(\scriptsize \log_{2}(N)+O(1)\)log2(N)+O(1) に修正されました。
LWG 577	C++98	last が返される可能性がありました。	許可
LWG 2150	C++98	もし [first, last) 内に、 bool(comp(value, *iter)) が true となるイテレータ iter が存在する場合、std::upper_bound は [iter, last) 内の任意のイテレータを返す可能性がありました。	iter より後のイテレータは 返されません。

関連項目

equal_range	特定のキーに一致する要素の範囲を返す (関数テンプレート)
lower_bound	与えられた値より小さくない最初の要素へのイテレータを返す (関数テンプレート)
partition	要素の範囲を2つのグループに分割する (関数テンプレート)
partition_point (C++11)	パーティション化された範囲のパーティションポイントを見つける (関数テンプレート)
ranges::upper_bound (C++20)	特定の値より大きい最初の要素へのイテレータを返す (アルゴリズム関数オブジェクト)
upper_bound	指定されたキーより大きい最初の要素へのイテレータを返す (std::set<Key,Compare,Allocator> の public メンバ関数)
upper_bound	指定されたキーより大きい最初の要素へのイテレータを返す (std::multiset<Key,Compare,Allocator> の public メンバ関数)