std::multimap equal_range() method

od C++14

// (1) Non const version
std::pair<iterator, iterator> equal_range( const Key& key );

// (2) Const version
std::pair<const_iterator, const_iterator> equal_range( const Key& key ) const;

// (3) Non const version
template< class K >
std::pair<iterator, iterator> equal_range( const K& x );

// (4) Const version
template< class K >
std::pair<const_iterator, const_iterator> equal_range( const K& x ) const;

od C++98

// (1) Non const version
std::pair<iterator, iterator> equal_range( const Key& key );

// (2) Const version
std::pair<const_iterator, const_iterator> equal_range( const Key& key ) const;

Returns a range containing all elements with the given key in the container. The range is defined by two iterators, one pointing to the first element that is not less than key and another pointing to the first element greater than key. Alternatively, the first iterator may be obtained with lower_bound(), and the second with upper_bound().

• (1-2) Compares the keys to key.
• (3-4) Compares the keys to the value x. This overload participates in overload resolution only if the qualified-id Compare::is_transparent is valid and denotes a type. It allows calling this function without constructing an instance of Key.

Parameters

• key - key value of the elements to count
• x - a value of any type that can be transparently compared with a key

Return value

std::pair containing a pair of iterators defining the wanted range: the first pointing to the first element that is not less than key and the second pointing to the first element greater than key.

If there are no elements not less than key, past-the-end (see end()) iterator is returned as the first element. Similarly if there are no elements greater than key, past-the-end iterator is returned as the second element.

od C++11

Since emplace() and unhinted insert() always insert at the upper bound, the order of equivalent elements in the equal range is the order of insertion unless hinted insert() or emplace_hint() was used to insert an element at a different position.

Complexity

Logarithmic in the size of the container - O(log size()).

Exceptions

(none)

Notes

Feature testing macro: __cpp_lib_generic_associative_lookup (for overloads (3) and (4)).

Examples

Main.cpp

#include <iostream>
#include <map>
 
int main()
{
    std::multimap<int, char> dict {
        {1, 'A'},
        {2, 'B'},
        {2, 'C'},
        {2, 'D'},
        {4, 'E'},
        {3, 'F'}
    };
 
    auto range = dict.equal_range(2);
 
    for (auto i = range.first; i != range.second; ++i)
    {
        std::cout << i->first << ": " << i->second << '\n';
    }
}

Output

2: B
2: C
2: D