std::multimap - cppreference.com (original) (raw)
| Defined in header | ||
|---|---|---|
| template< class Key, class T, class Compare = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>> > class multimap; | (1) | |
| namespace pmr { template< class Key, class T, class Compare = std::less<Key> > using multimap = std::multimap<Key, T, Compare, std::pmr::polymorphic_allocator<std::pair<const Key, T>>>; } | (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 function Compare, applied to the keys. Search, insertion, and removal operations have logarithmic complexity.
Iterators of std::multimap iterate in non-descending order of keys, where non-descending is defined by the comparison that was used for construction. That is, given
- m, a
std::multimap - it_l and it_r, dereferenceable iterators to m, with it_l < it_r.
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 the Compare requirements, equivalence is determined by using the equivalence relation as described on Compare. In imprecise terms, two objects a and b are considered equivalent if neither compares less than the other: !comp(a, b) && !comp(b, a).
std::multimap meets the requirements of Container, AllocatorAwareContainer, AssociativeContainer and ReversibleContainer.
| All member functions of std::multimap are constexpr: it is possible to create and use std::multimap objects in the evaluation of a constant expression.However, std::multimap objects generally cannot be constexpr, because any dynamically allocated storage must be released in the same evaluation of constant expression. | (since C++26) |
|---|
Contents
- 1 Template parameters
- 2 Member types
- 3 Member classes
- 4 Member functions
- 5 Non-member functions
- 6 Deduction guides
- 7 Notes
- 8 Example
- 9 Defect reports
- 10 See also
[edit] Template parameters
[edit] Member types
[edit] Member classes
[edit] Member functions
| (constructor) | constructs the multimap (public member function) [edit] |
|---|---|
| (destructor) | destructs the 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(C++11) | returns an iterator to the beginning (public member function) [edit] |
| endcend(C++11) | returns an iterator to the end (public member function) [edit] |
| rbegincrbegin(C++11) | returns a reverse iterator to the beginning (public member function) [edit] |
| rendcrend(C++11) | returns a reverse 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(C++11) | constructs element in-place (public member function) [edit] |
| emplace_hint(C++11) | 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] |
| lower_bound | returns an iterator to the first element not less than the given key (public member function) [edit] |
| upper_bound | returns an iterator to the first element greater than the given key (public member function) [edit] |
| Observers | |
| key_comp | returns the function that compares keys (public member function) [edit] |
| value_comp | returns the function that compares keys in objects of type value_type (public member function) [edit] |
[edit] Non-member functions
[edit] Notes
| 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) | constexpr std::multimap |
[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 230 | C++98 | Key was not required to be CopyConstructible(a key of type Key might not be able to be constructed) | Key is also required tobe CopyConstructible |
[edit] See also
| | collection of key-value pairs, sorted by keys, keys are unique (class template) [edit] | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | collection of key-value pairs, hashed by keys (class template) [edit] | | | adapts two containers to provide a collection of key-value pairs, sorted by keys (class template) [edit] |