Difference between revisions of "cpp/container/unordered multimap"

Latest revision as of 15:46, 1 November 2024

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

std::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.

Type	Definition
`key_type`	`Key`[edit]
`mapped_type`	`T`[edit]
`value_type`	std::pair<const Key, T>[edit]
`size_type`	Unsigned integer type (usually std::size_t)[edit]
`difference_type`	Signed integer type (usually std::ptrdiff_t)[edit]
`hasher`	`Hash`[edit]
`key_equal`	`KeyEqual`[edit]
`allocator_type`	`Allocator`[edit]
`reference`	value_type&[edit]
`const_reference`	const value_type&[edit]
`pointer`	std::allocator_traits<Allocator>::pointer[edit]
`const_pointer`	std::allocator_traits<Allocator>::const_pointer[edit]
`iterator`	LegacyForwardIterator to `value_type`[edit]
`const_iterator`	LegacyForwardIterator to const value_type[edit]
`local_iterator`	An iterator type whose category, value, difference, pointer and reference types are the same as `iterator`. This iterator can be used to iterate through a single bucket but not across buckets[edit]
`const_local_iterator`	An iterator type whose category, value, difference, pointer and reference types are the same as `const_iterator`. This iterator can be used to iterate through a single bucket but not across buckets[edit]
`node_type` (since C++17)	a specialization of node handle representing a container node[edit]

[edit] Member functions

(constructor)	constructs the `unordered_multimap` (public member function) [edit]
(destructor)	destructs the `unordered_multimap` (public member function) [edit]
operator=	assigns values to the container (public member function) [edit]
get_allocator	returns the associated allocator (public member function) [edit]
Iterators
begincbegin	returns an iterator to the beginning (public member function) [edit]
endcend	returns an iterator to the end (public member function) [edit]
Capacity
empty	checks whether the container is empty (public member function) [edit]
size	returns the number of elements (public member function) [edit]
max_size	returns the maximum possible number of elements (public member function) [edit]
Modifiers
clear	clears the contents (public member function) [edit]
insert	inserts elements or nodes(since C++17) (public member function) [edit]
insert_range (C++23)	inserts a range of elements (public member function) [edit]
emplace	constructs element in-place (public member function) [edit]
emplace_hint	constructs elements in-place using a hint (public member function) [edit]
erase	erases elements (public member function) [edit]
swap	swaps the contents (public member function) [edit]
extract (C++17)	extracts nodes from the container (public member function) [edit]
merge (C++17)	splices nodes from another container (public member function) [edit]
Lookup
count	returns the number of elements matching specific key (public member function) [edit]
find	finds element with specific key (public member function) [edit]
contains (C++20)	checks if the container contains element with specific key (public member function) [edit]
equal_range	returns range of elements matching a specific key (public member function) [edit]
Bucket interface
begin(size_type)cbegin(size_type)	returns an iterator to the beginning of the specified bucket (public member function) [edit]
end(size_type)cend(size_type)	returns an iterator to the end of the specified bucket (public member function) [edit]
bucket_count	returns the number of buckets (public member function) [edit]
max_bucket_count	returns the maximum number of buckets (public member function) [edit]
bucket_size	returns the number of elements in specific bucket (public member function) [edit]
bucket	returns the bucket for specific key (public member function) [edit]
Hash policy
load_factor	returns average number of elements per bucket (public member function) [edit]
max_load_factor	manages maximum average number of elements per bucket (public member function) [edit]
rehash	reserves at least the specified number of buckets and regenerates the hash table (public member function) [edit]
reserve	reserves space for at least the specified number of elements and regenerates the hash table (public member function) [edit]
Observers
hash_function	returns function used to hash the keys (public member function) [edit]
key_eq	returns the function used to compare keys for equality (public member function) [edit]

[edit] Non-member functions

operator==operator!= (C++11)(C++11)(removed in C++20)	compares the values in the unordered_multimap (function template) [edit]
std::swap(std::unordered_multimap) (C++11)	specializes the std::swap algorithm (function template) [edit]
erase_if(std::unordered_multimap) (C++20)	erases all elements satisfying specific criteria (function template) [edit]

Deduction guides

(since C++17)

[edit] Notes

Feature-test macro	Value	Std	Feature
`__cpp_lib_containers_ranges`	202202L	(C++23)	Ranges construction and insertion for containers

[edit] Example

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 2050	C++11	the definitions of `reference`, `const_reference`, `pointer` and `const_pointer` were based on `allocator_type`	based on `value_type` and std::allocator_traits

[edit] See also

unordered_map (C++11)	collection of key-value pairs, hashed by keys, keys are unique (class template) [edit]
multimap	collection of key-value pairs, sorted by keys (class template) [edit]
flat_multimap (C++23)	adapts two containers to provide a collection of key-value pairs, sorted by keys (class template) [edit]

@@ Line 39: / Line 39: @@
 ===Member types===
 {{dsc begin}}
-{{dsc hitem|Member type|Definition}}
+{{dsc hitem|Type|Definition}}
 {{dsc inc|cpp/container/dsc key_type|unordered_multimap}}
 {{dsc inc|cpp/container/dsc mapped_type|unordered_multimap}}
@@ Line 118: / Line 118: @@
 {{dsc end}}
-{{rrev|noborder=true|since=c++17|{{=}}{{=}}{{=}}{{rl|deduction guides|Deduction guides}}{{=}}{{=}}{{=}}}}
+{{rrev|since=c++17|
+==={{rl|deduction guides|Deduction guides}}===
+}}
 ===Notes===
@@ Line 132: / Line 134: @@
 {{dr list item|wg=lwg|dr=2050|std=C++11|before=the definitions of {{tt|reference}}, {{tt|const_reference}}, {{tt|pointer}}<br>and {{tt|const_pointer}} were based on {{tt|allocator_type}}|after=based on {{tt|value_type}} and<br>{{lc|std::allocator_traits}}}}
 {{dr list end}}
+===See also===
+{{dsc begin}}
+{{dsc inc|cpp/container/dsc unordered_map}}
+{{dsc inc|cpp/container/dsc multimap}}
+{{dsc inc|cpp/container/dsc flat_multimap}}
+{{dsc end}}
 {{langlinks|de|es|fr|it|ja|pt|ru|zh}}

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

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

cppreference.com

Namespaces

Variants

Views

Actions

Difference between revisions of "cpp/container/unordered multimap"

Latest revision as of 15:46, 1 November 2024

Contents

[edit] Template parameters

[edit] Member types

[edit] Member functions

Iterators

Capacity

Modifiers

Lookup

Bucket interface

Hash policy

Observers