std::binary_search

template< class ForwardIt, class T >
bool binary_search( ForwardIt first, ForwardIt last,
                    const T& value );

template< class ForwardIt, class T = typename std::iterator_traits
                                         <ForwardIt>::value_type >
constexpr bool binary_search( ForwardIt first, ForwardIt last,
                              const T& value );

template< class ForwardIt, class T, class Compare >
bool binary_search( ForwardIt first, ForwardIt last,
                    const T& value, Compare comp );

template< class ForwardIt, class T = typename std::iterator_traits
                                         <ForwardIt>::value_type,
          class Compare >
constexpr bool binary_search( ForwardIt first, ForwardIt last,
                              const T& value, Compare comp );

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

• Для любого элемента elem из [first, last) из bool(comp(elem, value)) не следует !bool(comp(value, elem)).
• Элементы elem из [first, last) не разбиты на части относительно выражений bool(comp(elem, value)) и !bool(comp(value, elem)).

Параметры

Возвращаемое значение

true, если найден элемент, эквивалентный value, и false в противном случае.

Сложность

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

Однако, если ForwardIt не является LegacyRandomAccessIterator, количество приращений итератора линейно относительно \(\scriptsize N\)N.

Примечания

Хотя std::binary_search требует только, чтобы [first, last) был разбит на части, обычно этот алгоритм используется в тех случаях, когда [first, last) отсортирован, поэтому двоичный поиск корректен для любого value.

std::binary_search лишь проверяет, существует ли эквивалентный элемент. Чтобы получить итератор на этот элемент (если он существует), следует использовать std::lower_bound.

Возможная реализация

См. также реализации в libstdc++ и libc++.

template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type>
bool binary_search(ForwardIt first, ForwardIt last, const T& value)
{
    return std::binary_search(first, last, value, std::less{});
}

template<class ForwardIt, class T = typename std::iterator_traits<ForwardIt>::value_type,
         class Compare>
bool binary_search(ForwardIt first, ForwardIt last, const T& value, Compare comp)
{
    first = std::lower_bound(first, last, value, comp);
    return (!(first == last) and !(comp(value, *first)));
}

Пример

#include <algorithm>
#include <cassert>
#include <complex>
#include <iostream>
#include <vector>

int main()
{
    const auto haystack = {1, 3, 4, 5, 9};
    
    for (const auto needle : {1, 2, 3})
    {
        std::cout << "Searching for " << needle << '\n';
        if (std::binary_search(haystack.begin(), haystack.end(), needle))
            std::cout << "Found " << needle << '\n';
        else
            std::cout << "Not found!\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::binary_search(nums.cbegin(), nums.cend(), {4, 2}, cmpz));
    #else
        assert(std::binary_search(nums.cbegin(), nums.cend(), CD{4, 2}, cmpz));
    #endif
}

Searching for 1
Found 1
Searching for 2
Not found!
Searching for 3
Found 3

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены задним числом к ранее опубликованным стандартам C++.

См. также