std::unordered_map
<unordered_map>
class Key,
class T,
class Hash = std::hash <Key>,
class KeyEqual = std::equal_to <Key>,
class Allocator = std::allocator <std::pair <const Key, T>>
template<
class Key,
class T,
class Hash = std::hash <Key>,
class KeyEqual = std::equal_to <Key>
> using unordered_map =
std::unordered_map<Key, T, Hash, KeyEqual,
std::pmr::polymorphic_allocator <std::pair <const Key, T>>>;
std::unordered_map
is an associative container that contains key-value pairs with unique keys. Search, insertion, and removal of elements 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. Keys with the same hash code appear in the same bucket. This allows fast access to individual elements, since once the hash is computed, it refers to the bucket containing the element.
Two keys are considered equivalent if the map's key equality predicate returns true when passed those keys. If two keys are equivalent, the hash function must return the same value for both keys.
std::unordered_map
meets the requirements of Container, AllocatorAwareContainer, UnorderedAssociativeContainer.
std::unordered_map
are constexpr: it is possible to create and use std::unordered_map
objects in the evaluation of a constant expression.However, std::unordered_map
objects generally cannot be constexpr, because any dynamically allocated storage must be released in the same evaluation of constant expression.
Contents
[edit] Iterator invalidation
Operations | Invalidated |
---|---|
All read only operations, swap , std::swap | Never |
clear , rehash , reserve , operator= | Always |
insert , emplace , emplace_hint , operator[] | Only if causes rehash |
erase | Only to the element erased |
[edit] Notes
- The swap functions do not invalidate any of the iterators inside the container, but they do invalidate the iterator marking the end of the swap region.
- References and pointers to either key or data stored in the container are only invalidated by erasing that element, even when the corresponding iterator is invalidated.
[edit] Template parameters
Reason: Add descriptions of the template parameters.
[edit] Member types
local_iterator
An iterator type whose category, value, difference, pointer andreference types are the same as
iterator
. This iteratorcan be used to iterate through a single bucket but not across buckets[edit]
const_local_iterator
An iterator type whose category, value, difference, pointer andreference types are the same as
const_iterator
. This iteratorcan be used to iterate through a single bucket but not across buckets[edit]
insert_return_type
(since C++17)
type describing the result of inserting a node_type
, a specialization oftemplate<class Iter, class NodeType>
struct /*unspecified*/
{
Iter position;
bool inserted;
NodeType node;
};
instantiated with template arguments iterator
and node_type
.[edit]
[edit] Member functions
Iterators
Capacity
Modifiers
(public member function) [edit]
(public member function) [edit]
Lookup
Bucket interface
Hash policy
(public member function) [edit]
(public member function) [edit]
Observers
[edit] Non-member functions
(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 |
__cpp_lib_constexpr_unordered_map |
202502L |
(C++26) | constexpr std::unordered_map
|
[edit] Example
#include <iostream> #include <string> #include <unordered_map> int main() { // Create an unordered_map of three strings (that map to strings) std::unordered_map<std::string, std::string > u = { {"RED", "#FF0000"}, {"GREEN", "#00FF00"}, {"BLUE", "#0000FF"} }; // Helper lambda function to print key-value pairs auto print_key_value = [](const auto& key, const auto& value) { std::cout << "Key:[" << key << "] Value:[" << value << "]\n"; }; std::cout << "Iterate and print key-value pairs of unordered_map, being\n" "explicit with their types:\n"; for (const std::pair <const std::string, std::string >& n : u) print_key_value(n.first, n.second); std::cout << "\nIterate and print key-value pairs using C++17 structured binding:\n"; for (const auto& [key, value] : u) print_key_value(key, value); // Add two new entries to the unordered_map u["BLACK"] = "#000000"; u["WHITE"] = "#FFFFFF"; std::cout << "\nOutput values by key:\n" "The HEX of color RED is:[" << u["RED"] << "]\n" "The HEX of color BLACK is:[" << u["BLACK"] << "]\n\n"; std::cout << "Use operator[] with non-existent key to insert a new key-value pair:\n"; print_key_value("new_key", u["new_key"]); std::cout << "\nIterate and print key-value pairs, using `auto`;\n" "new_key is now one of the keys in the map:\n"; for (const auto& n : u) print_key_value(n.first, n.second); }
Possible output:
Iterate and print key-value pairs of unordered_map, being explicit with their types: Key:[BLUE] Value:[#0000FF] Key:[GREEN] Value:[#00FF00] Key:[RED] Value:[#FF0000] Iterate and print key-value pairs using C++17 structured binding: Key:[BLUE] Value:[#0000FF] Key:[GREEN] Value:[#00FF00] Key:[RED] Value:[#FF0000] Output values by key: The HEX of color RED is:[#FF0000] The HEX of color BLACK is:[#000000] Use operator[] with non-existent key to insert a new key-value pair: Key:[new_key] Value:[] Iterate and print key-value pairs, using `auto`; new_key is now one of the keys in the map: Key:[new_key] Value:[] Key:[WHITE] Value:[#FFFFFF] Key:[BLACK] Value:[#000000] Key:[BLUE] Value:[#0000FF] Key:[GREEN] Value:[#00FF00] Key:[RED] Value:[#FF0000]
[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 andstd::allocator_traits |