std::{{{1}}}::equal_range

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Containers library

Sequence

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

deque

forward_list (C++11)

list

Associative

set

multiset

map

multimap

Unordered associative

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

Adaptors

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

Views

span (C++20)

mdspan (C++23)

Tables

Iterator invalidation

Member function table

Non-member function table

 

std::pair<iterator, iterator> equal_range( const Key& key );	(1)	(since {std})
std::pair<const_iterator, const_iterator> equal_range( const Key& key ) const;	(2)	(since {std})
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 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 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 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.

(since C++11)

Complexity

Logarithmic in the size of the container.

Notes

Feature-test macro	Value	Std	Feature
__cpp_lib_generic_associative_lookup	201304L	(C++14)	Heterogeneous comparison lookup in associative containers, for overloads (3,4)

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 of std::{{{1}}})
contains (C++20)	checks if the container contains element with specific key (public member function of std::{{{1}}})
count	returns the number of elements matching specific key (public member function of std::{{{1}}})
upper_bound	returns an iterator to the first element greater than the given key (public member function of std::{{{1}}})
lower_bound	returns an iterator to the first element not less than the given key (public member function of std::{{{1}}})
equal_range	returns range of elements matching a specific key (function template)