std::unordered_multiset equal_range() method

od C++20

// (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++11

// (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;

• (1-2) Returns a range containing all elements with key key in the container. The range is defined by two iterators, the first pointing to the first element of the wanted range and the second pointing past the last element of the range.
• (3-4) Returns a range containing all elements in the container with key equivalent to x. This overload participates in overload resolution only if Hash::is_transparent and KeyEqual::is_transparent are valid and each denotes a type. This assumes that such Hash is callable with both K and Key type, and that the KeyEqual is transparent, which, together, 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.

If there are no such elements, past-the-end (see end()) iterators are returned as both elements of the pair.

Complexity

Average case, linear in the number of elements with the key key - O(N), where N is number of elements with the key key.
Worst case, linear in the size of the container - O(size()).

Exceptions

(none)

Notes

Feature testing macro: __cpp_lib_generic_unordered_lookup (for overload (3-4)).

Example

Main.cpp

#include <iostream>
#include <iterator>
#include <string>
#include <unordered_set>
 
int main()
{
    std::string sentence{"cppreference.com"};
    std::cout << "The sentence: " << sentence << '\n';
 
    std::unordered_multiset<char> sequence;
    for (char x : sentence) { sequence.insert(x); }
 
    std::cout << "The sequence: { ";
    for (char x : sequence) { std::cout << x << ' '; }
 
    std::cout << "}\n" "Symbol:Frequency: ";
    for (auto it = sequence.begin(); it != sequence.end(); ) {
        if (auto [first, last] = sequence.equal_range(*it); first != last) {
            std::cout << *first << ":" << std::distance(first, last) << "  ";
            it = last;
        } else {
            ++it;
        }
    }
}

Output

The sentence: cppreference.com
The sequence: { m o c c c p p r r e e e e f n . }
Symbol:Frequency: m:1  o:1  c:3  p:2  r:2  e:4  f:1  n:1  .:1