std::unordered_multimap (3) - Linux Manuals

std::unordered_multimap: std::unordered_multimap

NAME

std::unordered_multimap - std::unordered_multimap

Synopsis

Defined in header <unordered_map>
template<
class Key,
class T,
class Hash = std::hash<Key>, (1) (since C++11)
class KeyEqual = std::equal_to<Key>,
class Allocator = std::allocator< std::pair<const Key, T> >
> class unordered_multimap;
namespace pmr {
template <class Key, class T,
class Hash = std::hash<Key>,
class Pred = std::equal_to<Key>> (2) (since C++17)
using unordered_multimap = std::unordered_multimap<Key, T, Hash, Pred,
std::pmr::polymorphic_allocator<std::pair<const Key,T>>>;
}

Unordered multimap is an unordered associative container that supports equivalent keys (an unordered_multimap may contain multiple copies of each key value) and that associates values of another type with the keys. The unordered_multimap class supports forward iterators. Search, insertion, and removal have average constant-time complexity.
Internally, the elements are not sorted in any particular order, but organized into buckets. Which bucket an element is placed into depends entirely on the hash of its key. This allows fast access to individual elements, since once the hash is computed, it refers to the exact bucket the element is placed into.
The iteration order of this container is not required to be stable (so, for example, std::equal cannot be used to compare two std::unordered_multimaps), except that every group of elements whose keys compare equivalent (compare equal with key_eq() as the comparator) forms a contiguous subrange in the iteration order, also accessible with equal_range().
std::unordered_multimap meets the requirements of Container, AllocatorAwareContainer, UnorderedAssociativeContainer.

Member types

Member type Definition
key_type Key
mapped_type T
value_type std::pair<const Key, T>
size_type Unsigned integer type (usually std::size_t)
difference_type Signed integer type (usually std::ptrdiff_t)
hasher Hash

key_equal KeyEqual (until C++20)
                       Hash::transparent_key_equal if defined and names a type, otherwise KeyEqual (since C++20)

allocator_type Allocator
reference value_type&
const_reference const value_type&
pointer std::allocator_traits<Allocator>::pointer
const_pointer std::allocator_traits<Allocator>::const_pointer
iterator LegacyForwardIterator
const_iterator Constant LegacyForwardIterator
                       An iterator type whose category, value, difference, pointer and
local_iterator reference types are the same as iterator. This iterator
                       can be used to iterate through a single bucket but not across buckets
                       An iterator type whose category, value, difference, pointer and
const_local_iterator reference types are the same as const_iterator. This iterator
                       can be used to iterate through a single bucket but not across buckets
node_type(since C++17) a specialization of node_handle representing a container node

Member functions

                  constructs the unordered_multimap
constructor (public member function)
                  destructs the unordered_multimap
destructor (public member function)
                  assigns values to the container
operator= (public member function)
                  returns the associated allocator
get_allocator (public member function)

Iterators

begin returns an iterator to the beginning
cbegin (public member function)

end_ returns an iterator to the end
cend (public member function)

Capacity

                  checks whether the container is empty
empty (public member function)
                  returns the number of elements
size (public member function)
                  returns the maximum possible number of elements
max_size (public member function)

Modifiers

                  clears the contents
clear (public member function)
                  inserts elements
                  or nodes
insert (since C++17)
                  (public member function)
                  constructs element in-place
emplace (public member function)
                  constructs elements in-place using a hint
emplace_hint (public member function)
                  erases elements
erase (public member function)
                  swaps the contents
swap (public member function)

extract extracts nodes from the container
                  (public member function)
(C++17)

merge splices nodes from another container
                  (public member function)
(C++17)

Lookup

                  returns the number of elements matching specific key
count (public member function)
                  finds element with specific key
find (public member function)

contains checks if the container contains element with specific key
                  (public member function)
(C++20)
                  returns range of elements matching a specific key
equal_range (public member function)

Bucket interface

                  returns an iterator to the beginning of the specified bucket
begin(size_type) (public member function)
cbegin(size_type)
                  returns an iterator to the end of the specified bucket
end(size_type) (public member function)
cend(size_type)
                  returns the number of buckets
bucket_count (public member function)
                  returns the maximum number of buckets
max_bucket_count (public member function)
                  returns the number of elements in specific bucket
bucket_size (public member function)
                  returns the bucket for specific key
bucket (public member function)

Hash policy

                  returns average number of elements per bucket
load_factor (public member function)
                  manages maximum average number of elements per bucket
max_load_factor (public member function)
                  reserves at least the specified number of buckets.
rehash This regenerates the hash table.
                  (public member function)
                  reserves space for at least the specified number of elements.
reserve This regenerates the hash table.
                  (public member function)

Observers

                  returns function used to hash the keys
hash_function (public member function)
                  returns the function used to compare keys for equality
key_eq (public member function)

Non-member functions

                                   compares the values in the unordered_multimap
operator== (function template)
operator!=

std::swap(std::unordered_multimap) specializes the std::swap algorithm
                                   (function template)
(C++11)

erase_if(std::unordered_multimap) Erases all elements satisfying specific criteria
                                   (function template)
(C++20)

Deduction_guides(since C++17)