std::upper_bound

Определён в заголовочном файле `<algorithm>`
template< class ForwardIt, class T > ForwardIt upper_bound( ForwardIt first, ForwardIt last, const T& value );	(1)	(до C++26) (constexpr начиная с C++20)
template< class ForwardIt, class T = typename std::iterator_traits <ForwardIt>::value_type > constexpr ForwardIt upper_bound( ForwardIt first, ForwardIt last, const T& value );	(1)		(начиная с C++26)
template< class ForwardIt, class T, class Compare > ForwardIt upper_bound( ForwardIt first, ForwardIt last, const T& value, Compare comp );	(2)	(до 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 );	(2)		(начиная с C++26)

Выполняет поиск первого элемента в диапазоне [first, last), упорядоченного после value.

1) Порядок определяется с помощью operator<:

Возвращает первый итератор iter в [first, last), для которого bool(value < *iter) является true, либо last, если такого iter не существует.

Если элементы elem из [first, last) не разбиты на части относительно выражения !bool(value < elem), поведение не определено.

(до C++20)

Эквивалентно std::upper_bound(first, last, value, std::less{}).

(начиная с C++20)

2) Порядок определяется с помощью comp:

Возвращает первый итератор iter в [first, last), для которого bool(comp(value, *iter)) является true, либо last, если такого iter не существует.

Если элементы elem из [first, last) не разбиты на части относительно выражения !bool(comp(value, elem)), поведение не определено.

Параметры

first, last	-	пара итераторов, задающая разбитый на части диапазон элементов для проверки
value	-	значение, с которым сравниваются элементы
comp	-	бинарный предикат, возвращающий `true`, если первый аргумент упорядочен перед вторым. Сигнатура функции-предиката должна быть эквивалентна следующей: boolpred(constType1&a,constType2&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, если такой элемент не найден.

Сложность

Пусть \(\scriptsize N\)N — std::distance(first, last):

1) Не более \(\scriptsize \log_{2}(N)+O(1)\)log₂(N)+O(1) сравнений с value с использованием operator<(до C++20)std::less{}(начиная с C++20).

2) Не более \(\scriptsize \log_{2}(N)+O(1)\)log₂(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; }

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.

Для любого итератора iter в [first, last) для 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++.

Отчёт об ошибке	Применён к	Опубликованное поведение	Корректное поведение
LWG 270	C++98	От `Compare` требовалось соответствовать требованиям Compare, а от `T` требовалось соответствовать требованиям LessThanComparable (требовался строгий слабый порядок)	требуется только разбиение на части; разрешены разнородные сравнения
LWG 384	C++98	допускалось не более \(\scriptsize \log(N)+1\)log₂(N)+1 сравнений	исправлено на \(\scriptsize \log_{2}(N)+O(1)\)log₂(N)+O(1)
LWG 577	C++98	`last` нельзя было возвращать	разрешено
LWG 2150	C++98	если в `[first,` `last)` существует какой-либо итератор `iter`, для которого `bool(comp(value, *iter))` является `true`, `std::upper_bound` мог возвращать любой итератор в `[iter,` `last)`	нельзя возвращать итератор, стоящий после `iter`

См. также

equal_range	находит с помощью двоичного поиска диапазон элементов, соответствующих заданному значению (шаблон функции и функциональный объект-алгоритм)
ranges::equal_range (C++20)
lower_bound	находит с помощью двоичного поиска первый элемент, не меньший заданного значения (шаблон функции и функциональный объект-алгоритм)
ranges::lower_bound (C++20)
partition	разделяет диапазон элементов на две группы (шаблон функции и функциональный объект-алгоритм)
ranges::partition (C++20)
partition_point (C++11)	находит точку разделения в разбитом на части диапазоне (шаблон функции и функциональный объект-алгоритм)
ranges::partition_point (C++20)
ranges::upper_bound (C++20)	находит с помощью двоичного поиска первый элемент, больший заданного значения (функциональный объект-алгоритм)
upper_bound	возвращает итератор на первый элемент, больший заданного ключа (открытая функция-член `std::set<Key,Compare,Allocator>`)
upper_bound	возвращает итератор на первый элемент, больший заданного ключа (открытая функция-член `std::multiset<Key,Compare,Allocator>`)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/algorithm/upper_bound