std::multimap::equal_range

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Containers library

array (C++11)

vector

deque

forward_list (C++11)

list

set

multiset

map

multimap

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

stack

queue

priority_queue

 

std::multimap

Member functions

multimap::multimap

multimap::~multimap

multimap::operator=

multimap::get_allocator

Iterators

multimap::beginmultimap::cbegin (C++11)

multimap::endmultimap::cend (C++11)

multimap::rbeginmultimap::crbegin (C++11)

multimap::rendmultimap::crend (C++11)

Capacity

multimap::erase

multimap::size

multimap::max_size

Modifiers

multimap::clear

multimap::insert

multimap::emplace (C++11)

multimap::emplace_hint (C++11)

multimap::erase

multimap::swap

multimap::extract (C++17)

multimap::merge (C++17)

Lookup

multimap::count

multimap::find

multimap::equal_range

multimap::lower_bound

multimap::upper_bound

Observers

multimap::key_comp

multimap::value_comp

 

std::pair<iterator,iterator> equal_range( const Key& key );	(1)
std::pair<const_iterator,const_iterator> equal_range( const Key& key ) const;	(2)
template< class K > std::pair<iterator,iterator> equal_range( const K& x );	(3)	(since C++14)
template< class K > std::pair<const_iterator,const_iterator> equal_range( const K& x ) const;	(4)	(since C++14)

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 only participates in overload resolution if the qualified-id Compare::is_transparent is valid and denotes a type. They allow calling this function without constructing an instance of Key.

Parameters

key	-	key value to compare the elements to
x	-	alternative value that can be compared to 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.

Since insert always inserts at the upper bound, the order of equivalent elements in the equal range is the order of insertion.

(since C++11)

Complexity

Logarithmic in the size of the container.

Example

Run this code

#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

See also

find	finds element with specific key (public member function)
upper_bound	returns an iterator to the first element greater than the given key (public member function)
lower_bound	returns an iterator to the first element not less than the given key (public member function)