Difference between revisions of "cpp/container/unordered map"
m (fix comment misnomer, more general helper lambda and normalize last loop) |
|||
Line 159: | Line 159: | ||
// Helper lambda function to print key:value pairs | // Helper lambda function to print key:value pairs | ||
− | auto print_key_value = []( | + | auto print_key_value = [](const auto& key, const auto& value) { |
std::cout << "Key:[" << key << "] Value:[" << value << "]\n"; | std::cout << "Key:[" << key << "] Value:[" << value << "]\n"; | ||
}; | }; | ||
std::cout << "Iterate and print keys and values of unordered_map, being\n" | std::cout << "Iterate and print keys and values of unordered_map, being\n" | ||
− | "explicit with | + | "explicit with value type:\n"; |
for( const std::pair<const std::string, std::string>& n : u ) { | for( const std::pair<const std::string, std::string>& n : u ) { | ||
print_key_value(n.first, n.second); | print_key_value(n.first, n.second); | ||
Line 196: | Line 196: | ||
std::cout << "Iterating over the unordered_map shows `new_key` is now one\n" | std::cout << "Iterating over the unordered_map shows `new_key` is now one\n" | ||
"of the keys in the map:\n"; | "of the keys in the map:\n"; | ||
− | for( const | + | for( const auto& n : u ) { |
print_key_value(n.first, n.second); | print_key_value(n.first, n.second); | ||
} | } | ||
Line 203: | Line 203: | ||
| output= | | output= | ||
Iterate and print keys and values of unordered_map, being | Iterate and print keys and values of unordered_map, being | ||
− | explicit with | + | explicit with value type: |
Key:[BLUE] Value:[#0000FF] | Key:[BLUE] Value:[#0000FF] | ||
Key:[GREEN] Value:[#00FF00] | Key:[GREEN] Value:[#00FF00] | ||
Line 238: | Line 238: | ||
{{dsc begin}} | {{dsc begin}} | ||
{{dsc inc | cpp/container/dsc map}} | {{dsc inc | cpp/container/dsc map}} | ||
− | |||
{{dsc end}} | {{dsc end}} | ||
{{langlinks|de|es|fr|it|ja|ko|pt|ru|zh}} | {{langlinks|de|es|fr|it|ja|ko|pt|ru|zh}} |
Revision as of 07:49, 11 May 2022
Defined in header <unordered_map>
|
||
template< class Key, |
(1) | (since C++11) |
namespace pmr { template <class Key, |
(2) | (since C++17) |
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 exact bucket the element is placed into.
std::unordered_map
meets the requirements of Container, AllocatorAwareContainer, UnorderedAssociativeContainer.
Contents |
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 |
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.
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
|
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 to value_type
|
const_iterator
|
LegacyForwardIterator to const value_type |
local_iterator
|
An iterator type whose category, value, difference, pointer and reference types are the same as iterator . This iteratorcan be used to iterate through a single bucket but not across buckets |
const_local_iterator
|
An iterator type whose category, value, difference, pointer and reference types are the same as const_iterator . This iteratorcan 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 |
insert_return_type (since C++17)
|
type describing the result of inserting a node_type , a specialization oftemplate<class Iter, class NodeType> |
Member functions
constructs the unordered_map (public member function) | |
destructs the unordered_map (public member function) | |
assigns values to the container (public member function) | |
returns the associated allocator (public member function) | |
Iterators | |
returns an iterator to the beginning (public member function) | |
returns an iterator to the end (public member function) | |
Capacity | |
checks whether the container is empty (public member function) | |
returns the number of elements (public member function) | |
returns the maximum possible number of elements (public member function) | |
Modifiers | |
clears the contents (public member function) | |
inserts elements or nodes(since C++17) (public member function) | |
(C++17) |
inserts an element or assigns to the current element if the key already exists (public member function) |
constructs element in-place (public member function) | |
constructs elements in-place using a hint (public member function) | |
(C++17) |
inserts in-place if the key does not exist, does nothing if the key exists (public member function) |
erases elements (public member function) | |
swaps the contents (public member function) | |
(C++17) |
extracts nodes from the container (public member function) |
(C++17) |
splices nodes from another container (public member function) |
Lookup | |
access specified element with bounds checking (public member function) | |
access or insert specified element (public member function) | |
returns the number of elements matching specific key (public member function) | |
finds element with specific key (public member function) | |
(C++20) |
checks if the container contains element with specific key (public member function) |
returns range of elements matching a specific key (public member function) | |
Bucket interface | |
returns an iterator to the beginning of the specified bucket (public member function) | |
returns an iterator to the end of the specified bucket (public member function) | |
returns the number of buckets (public member function) | |
returns the maximum number of buckets (public member function) | |
returns the number of elements in specific bucket (public member function) | |
returns the bucket for specific key (public member function) | |
Hash policy | |
returns average number of elements per bucket (public member function) | |
manages maximum average number of elements per bucket (public member function) | |
reserves at least the specified number of buckets and regenerates the hash table (public member function) | |
reserves space for at least the specified number of elements and regenerates the hash table (public member function) | |
Observers | |
returns function used to hash the keys (public member function) | |
returns the function used to compare keys for equality (public member function) |
Non-member functions
(C++11)(C++11)(removed in C++20) |
compares the values in the unordered_map (function template) |
specializes the std::swap algorithm (function template) | |
(C++20) |
erases all elements satisfying specific criteria (function template) |
Deduction guides(since C++17)
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 keys and values of unordered_map, being\n" "explicit with value type:\n"; for( const std::pair<const std::string, std::string>& n : u ) { print_key_value(n.first, n.second); } std::cout << "\n"; std::cout << "Iterate and print keys and values of unordered_map,\n" "using auto:\n"; for( const auto& n : u ) { print_key_value(n.first, n.second); } std::cout << "\n"; std::cout << "Iterate and print keys and values using structured binding\n" "(since C++17):\n"; for( const auto& [key, value] : u ) { print_key_value(key, value); } std::cout << "\n"; // Add two new entries to the unordered_map u["BLACK"] = "#000000"; u["WHITE"] = "#FFFFFF"; std::cout << "Output values by key:\n"; std::cout << "The HEX of color RED is:[" << u["RED"] << "]\n"; std::cout << "The HEX of color BLACK is:[" << u["BLACK"] << "]\n\n"; // Use of operator[] with non-existent key inserts a new value print_key_value("new_key", u["new_key"]); std::cout << "Iterating over the unordered_map shows `new_key` is now one\n" "of the keys in the map:\n"; for( const auto& n : u ) { print_key_value(n.first, n.second); } }
Possible output:
Iterate and print keys and values of unordered_map, being explicit with value type: Key:[BLUE] Value:[#0000FF] Key:[GREEN] Value:[#00FF00] Key:[RED] Value:[#FF0000] Iterate and print keys and values of unordered_map, using auto: Key:[BLUE] Value:[#0000FF] Key:[GREEN] Value:[#00FF00] Key:[RED] Value:[#FF0000] Iterate and print keys and values using structured binding (since C++17): 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] Key:[new_key] Value:[] Iterating over the unordered_map shows `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]
See also
collection of key-value pairs, sorted by keys, keys are unique (class template) |