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 );

Retourne une plage contenant tous les éléments équivalents à value dans la plage partitionnée [first, last).

Paramètres

Valeur de retour

Un std::pair contenant une paire d'itérateurs, où

• first est un itérateur vers le premier élément de la plage [first, last) non ordonné avant value (ou last si aucun élément de ce type n'est trouvé), et
• second est un itérateur vers le premier élément de la plage [first, last) ordonné après value (ou last si aucun élément de ce type n'est trouvé).

Complexité

Étant donné \(\scriptsize N\)N comme std::distance(first, last) :

Cependant, si ForwardIt n'est pas un LegacyRandomAccessIterator, le nombre d'incréments d'itérateur est linéaire en \(\scriptsize N\)N. Notamment, les itérateurs de std::set et std::multiset ne sont pas à accès aléatoire, donc leurs fonctions membres std::set::equal_range (resp. std::multiset::equal_range) doivent être préférées.

Notes

Bien que std::equal_range exige seulement que [first, last) soit partitionnée, cet algorithme est généralement utilisé dans le cas où [first, last) est triée, afin que la recherche binaire soit valide pour toute value.

En plus des exigences de std::lower_bound et std::upper_bound, std::equal_range exige également que operator< ou comp soit asymétrique (c'est-à-dire que a < b et b < a aient toujours des résultats différents).

Par conséquent, les résultats intermédiaires de la recherche binaire peuvent être partagés par std::lower_bound et std::upper_bound. Par exemple, le résultat de l'appel std::lower_bound peut être utilisé comme argument de first dans l'appel std::upper_bound.

Implémentation possible

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));
}

Exemple

#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)

Rapports de défauts

Les rapports de défauts modifiant le comportement suivants ont été appliqués rétroactivement aux normes C++ précédemment publiées.

Voir aussi