std::equal_range

template< class ForwardIt, class T >
std::pair<ForwardIt, ForwardIt> 
    equal_range( ForwardIt first, ForwardIt last, const T& value );

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

template< class ForwardIt, class T, class Compare >
std::pair<ForwardIt, ForwardIt> 
    equal_range( ForwardIt first, ForwardIt last,
                 const T& value, Compare comp );

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

Gibt einen Bereich zurück, der alle Elemente enthält, die äquivalent zu value im partitionierten Bereich [first, last) sind.

Parameter

Rückgabewert

Ein std::pair, das ein Paar von Iteratoren enthält, wobei

• first ein Iterator auf das erste Element des Bereichs [first, last) ist, das nicht vor value geordnet ist (oder last, wenn kein solches Element gefunden wird), und
• second ein Iterator auf das erste Element des Bereichs [first, last) ist, das nach value geordnet ist (oder last, wenn kein solches Element gefunden wird).

Komplexität

Gegeben \(\scriptsize N\)N als std::distance(first, last):

Falls ForwardIt jedoch kein LegacyRandomAccessIterator ist, ist die Anzahl der Iteratorinkremente linear in \(\scriptsize N\)N. Insbesondere sind Iteratoren von std::set und std::multiset keine Direktzugriffsiteratoren, daher sollten deren Mitgliedsfunktionen std::set::equal_range (bzw. std::multiset::equal_range) bevorzugt werden.

Anmerkungen

Obwohl std::equal_range nur verlangt, dass [first, last) partitioniert ist, wird dieser Algorithmus normalerweise in dem Fall verwendet, dass [first, last) sortiert ist, damit die binäre Suche für jedes value gültig ist.

Zusätzlich zu den Anforderungen von std::lower_bound und std::upper_bound erfordert std::equal_range auch, dass operator< oder comp asymmetrisch ist (d. h., a < b und b < a haben immer unterschiedliche Ergebnisse).

Daher können die Zwischenergebnisse der binären Suche von std::lower_bound und std::upper_bound gemeinsam genutzt werden. Beispielsweise kann das Ergebnis des std::lower_bound-Aufrufs als Argument von first im std::upper_bound-Aufruf verwendet werden.

Mögliche Implementierung

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

template<class ForwardIt,
         class T = typename std::iterator_traits<ForwardIt>::value_type,
         class Compare>
constexpr std::pair<ForwardIt, ForwardIt>
    equal_range(ForwardIt first, ForwardIt last, const T& value, Compare comp)
{
    return std::make_pair(std::lower_bound(first, last, value, comp),
                          std::upper_bound(first, last, value, comp));
}

Beispiel

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

struct S
{
    int number;
    char name;
    // note: name is ignored by this comparison operator
    bool operator<(const S& s) const { return number < s.number; }
};

struct Comp
{
    bool operator()(const S& s, int i) const { return s.number < i; }
    bool operator()(int i, const S& s) const { return i < s.number; }
};

int main()
{
    // note: not ordered, only partitioned w.r.t. S defined below
    const std::vector<S> vec{{1, 'A'}, {2, 'B'}, {2, 'C'},
                             {2, 'D'}, {4, 'G'}, {3, 'F'}};
    const S value{2, '?'};
    
    std::cout << "Compare using S::operator<(): ";
    const auto p = std::equal_range(vec.begin(), vec.end(), value);
    
    for (auto it = p.first; it != p.second; ++it)
        std::cout << it->name << ' ';
    std::cout << '\n';
    
    std::cout << "Using heterogeneous comparison: ";
    const auto p2 = std::equal_range(vec.begin(), vec.end(), 2, Comp{});
    
    for (auto it = p2.first; it != p2.second; ++it)
        std::cout << it->name << ' ';
    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 p3 = std::equal_range(nums.cbegin(), nums.cend(), {2, 0}, cmpz);
    #else
        auto p3 = std::equal_range(nums.cbegin(), nums.cend(), CD{2, 0}, cmpz);
    #endif

    for (auto it = p3.first; it != p3.second; ++it)
        std::cout << *it << ' ';
    std::cout << '\n';
}

Compare using S::operator<(): B C D 
Using heterogeneous comparison: B C D
(2,2) (2, 1)

Fehlerberichte

Die folgenden verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

Siehe auch