std::unordered_map<Key,T,Hash,KeyEqual,Allocator>::equal_range

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms 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

span (C++20)

 

std::unordered_map

Member functions

unordered_map::unordered_map

unordered_map::~unordered_map

unordered_map::operator=

unordered_map::get_allocator

Iterators

unordered_map::beginunordered_map::cbegin

unordered_map::endunordered_map::cend

Capacity

unordered_map::empty

unordered_map::size

unordered_map::max_size

Modifiers

unordered_map::clear

unordered_map::insert

unordered_map::insert_or_assign (C++17)

unordered_map::emplace

unordered_map::emplace_hint

unordered_map::try_emplace (C++17)

unordered_map::erase

unordered_map::swap

unordered_map::extract (C++17)

unordered_map::merge (C++17)

Lookup

unordered_map::at

unordered_map::operator[]

unordered_map::count

unordered_map::find

unordered_map::contains (C++20)

unordered_map::equal_range

Bucket interface

unordered_map::begin(size_type)unordered_map::cbegin(size_type)

unordered_map::end(size_type)unordered_map::cend(size_type)

unordered_map::bucket_count

unordered_map::max_bucket_count

unordered_map::bucket_size

unordered_map::bucket

Hash policy

unordered_map::load_factor

unordered_map::max_load_factor

unordered_map::rehash

unordered_map::reserve

Observers

unordered_map::hash_function

unordered_map::key_eq

Deduction guides(C++17)

 

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

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 only participates in overload resolution if the qualified-id Hash::transparent_key_equal is valid and denotes a type. This assumes that such Hash is callable with both K and Key type, and that its key_equal is transparent, which, together, allows calling this function without constructing an instance of Key.

If present, the hash parameter may be used to pass a pre-computed hash value as an optimization. The behavior is undefined if invoking hash_function() on the key passed do not produce the same value as hash.

(since C++20)

Parameters

key	-	key value to compare the elements to
x	-	a value of any type that can be transparently compared with a key
hash	-	the hash value of the 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, worst case linear in the size of the container.

Example

Run this code

#include <iostream>
#include <unordered_map>
 
int main()
{  
    std::unordered_map<int,char> map = {{1,'a'},{1,'b'},{1,'d'},{2,'b'}};
    auto range = map.equal_range(1);
    for (auto it = range.first; it != range.second; ++it) {
        std::cout << it->first << ' ' << it->second << '\n';
    }
}

Output:

1 a

See also

find	finds element with specific key (public member function)