(C++17) | ||||
Sequence | ||||
(C++11) | ||||
(C++26) | ||||
(C++26) | ||||
(C++11) | ||||
Associative | ||||
multimap | ||||
Unordered associative | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
Adaptors | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
Views | ||||
(C++20) | ||||
(C++23) | ||||
Tables | ||||
Iterator invalidation | ||||
Member function table | ||||
Non-member function table |
Member functions | |||||||
Non-member functions | |||||||
| |||||||
Deduction guides(C++17) |
Defined in header <map> | ||
template< class Key, | (1) | |
namespace pmr{ template< | (2) | (since C++17) |
std::multimap
is an associative container that contains a sorted list of key-value pairs, while permitting multiple entries with the same key. Sorting is done according to the comparison functionCompare
, applied to the keys. Search, insertion, and removal operations have logarithmic complexity.
Iterators ofstd::multimap
iterate in non-descending order of keys, where non-descending is defined by the comparison that was used for construction. That is, given
std::multimap
m.value_comp()(*it_r,*it_l)==false (least to greatest if using the default comparison).
The order of the key-value pairs whose keys compare equivalent is the order of insertion and does not change. | (since C++11) |
Everywhere the standard library uses theCompare requirements, equivalence is determined by using the equivalence relation as described onCompare. In imprecise terms, two objectsa andb are considered equivalent if neither compares less than the other:!comp(a, b)&&!comp(b, a).
std::multimap
meets the requirements ofContainer,AllocatorAwareContainer,AssociativeContainer andReversibleContainer.
All member functions ofstd::multimap areconstexpr: it is possible to create and usestd::multimap objects in the evaluation of a constant expression.However, | (since C++26) |
Contents |
This section is incomplete Reason: Add descriptions of the template parameters. |
Type | Definition | ||||
key_type | Key [edit] | ||||
mapped_type | T [edit] | ||||
value_type | std::pair<const Key, T>[edit] | ||||
size_type | Unsigned integer type (usuallystd::size_t)[edit] | ||||
difference_type | Signed integer type (usuallystd::ptrdiff_t)[edit] | ||||
key_compare | Compare [edit] | ||||
allocator_type | Allocator [edit] | ||||
reference | value_type&[edit] | ||||
const_reference | const value_type&[edit] | ||||
pointer |
| ||||
const_pointer |
| ||||
iterator | LegacyBidirectionalIterator andConstexprIterator(since C++26) tovalue_type [edit] | ||||
const_iterator | LegacyBidirectionalIterator andConstexprIterator(since C++26) toconst value_type[edit] | ||||
reverse_iterator | std::reverse_iterator<iterator>[edit] | ||||
const_reverse_iterator | std::reverse_iterator<const_iterator>[edit] | ||||
node_type (since C++17) | a specialization ofnode handle representing a container node[edit] |
compares objects of typevalue_type (class)[edit] |
constructs themultimap (public member function)[edit] | |
destructs themultimap (public member function)[edit] | |
assigns values to the container (public member function)[edit] | |
returns the associated allocator (public member function)[edit] | |
Iterators | |
(C++11) | returns an iterator to the beginning (public member function)[edit] |
(C++11) | returns an iterator to the end (public member function)[edit] |
(C++11) | returns a reverse iterator to the beginning (public member function)[edit] |
(C++11) | returns a reverse iterator to the end (public member function)[edit] |
Capacity | |
checks whether the container is empty (public member function)[edit] | |
returns the number of elements (public member function)[edit] | |
returns the maximum possible number of elements (public member function)[edit] | |
Modifiers | |
clears the contents (public member function)[edit] | |
inserts elementsor nodes(since C++17) (public member function)[edit] | |
(C++23) | inserts a range of elements (public member function)[edit] |
(C++11) | constructs element in-place (public member function)[edit] |
(C++11) | constructs elements in-place using a hint (public member function)[edit] |
erases elements (public member function)[edit] | |
swaps the contents (public member function)[edit] | |
(C++17) | extracts nodes from the container (public member function)[edit] |
(C++17) | splices nodes from another container (public member function)[edit] |
Lookup | |
returns the number of elements matching specific key (public member function)[edit] | |
finds element with specific key (public member function)[edit] | |
(C++20) | checks if the container contains element with specific key (public member function)[edit] |
returns range of elements matching a specific key (public member function)[edit] | |
returns an iterator to the first elementnot less than the given key (public member function)[edit] | |
returns an iterator to the first elementgreater than the given key (public member function)[edit] | |
Observers | |
returns the function that compares keys (public member function)[edit] | |
returns the function that compares keys in objects of typevalue_type (public member function)[edit] |
(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(removed in C++20)(C++20) | lexicographically compares the values of twomultimap s(function template)[edit] |
specializes thestd::swap algorithm (function template)[edit] | |
(C++20) | erases all elements satisfying specific criteria (function template)[edit] |
Deduction guides | (since C++17) |
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_containers_ranges | 202202L | (C++23) | Ranges construction and insertion for containers |
__cpp_lib_constexpr_map | 202502L | (C++26) | constexprstd::multimap |
This section is incomplete Reason: no example |
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 230 | C++98 | Key was not required to beCopyConstructible(a key of type Key might not be able to be constructed) | Key is also required tobeCopyConstructible |
collection of key-value pairs, sorted by keys, keys are unique (class template)[edit] | |
(C++11) | collection of key-value pairs, hashed by keys (class template)[edit] |
(C++23) | adapts two containers to provide a collection of key-value pairs, sorted by keys (class template)[edit] |