Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | container
(looks like we never actually explained what key equivalence means but it's used it in many member pages. Roughly following https://eel.is/c++draft/unord.req#general-5)
m (→‎Member types: ~Type)
 
(26 intermediate revisions by 12 users not shown)
Line 3: Line 3:
 
{{dcl begin}}
 
{{dcl begin}}
 
{{dcl header|unordered_map}}
 
{{dcl header|unordered_map}}
−
{{dcl|num=1||since=c++11|1=
+
{{dcl|num=1|since=c++11|1=
 
template<
 
template<
 
     class Key,
 
     class Key,
Line 9: Line 9:
 
     class Hash = std::hash<Key>,
 
     class Hash = std::hash<Key>,
 
     class KeyEqual = std::equal_to<Key>,
 
     class KeyEqual = std::equal_to<Key>,
−
     class Allocator = std::allocator< std::pair<const Key, T> >
+
     class Allocator = std::allocator<std::pair<const Key, T>>
 
> class unordered_map;
 
> class unordered_map;
 
}}
 
}}
 
{{dcl|num=2|since=c++17|1=
 
{{dcl|num=2|since=c++17|1=
 
namespace pmr {
 
namespace pmr {
−
template <
+
    template<
−
    class Key,
+
        class Key,
−
    class T,
+
        class T,
−
    class Hash = std::hash<Key>,
+
        class Hash = std::hash<Key>,
−
    class KeyEqual = std::equal_to<Key>
+
        class KeyEqual = std::equal_to<Key>
−
> using unordered_map = std::unordered_map<Key, T, Hash, KeyEqual,
+
    > using unordered_map =
−
                            std::pmr::polymorphic_allocator<std::pair<const Key,T>>>;
+
          std::unordered_map<Key, T, Hash, KeyEqual,
 +
              std::pmr::polymorphic_allocator<std::pair<const Key, T>>>;
 
}
 
}
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
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.
+
{{tt|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 exact bucket the element is placed into.
 
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.
Line 34: Line 35:
  
 
===Iterator invalidation===
 
===Iterator invalidation===
−
 
+
{|class="dsctable" style="font-size:1.0em"
−
{|class="dsctable" style="font-size:0.8em"
+
!Operations
−
! Operations
+
!Invalidated
−
! Invalidated
+
 
|-
 
|-
 
|All read only operations, {{lc|swap}}, {{lc|std::swap}}
 
|All read only operations, {{lc|swap}}, {{lc|std::swap}}
Line 56: Line 56:
  
 
* 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.
 
* 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.
 +
 +
===Template parameters===
 +
{{todo|Add descriptions of the template parameters.}}
  
 
===Member types===
 
===Member types===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc hitem|Member type|Definition}}
+
{{dsc hitem|Type|Definition}}
 
{{dsc inc|cpp/container/dsc key_type|unordered_map}}
 
{{dsc inc|cpp/container/dsc key_type|unordered_map}}
 
{{dsc inc|cpp/container/dsc mapped_type|unordered_map}}
 
{{dsc inc|cpp/container/dsc mapped_type|unordered_map}}
Line 99: Line 102:
 
{{dsc inc|cpp/container/dsc clear|unordered_map}}
 
{{dsc inc|cpp/container/dsc clear|unordered_map}}
 
{{dsc inc|cpp/container/dsc insert|unordered_map}}
 
{{dsc inc|cpp/container/dsc insert|unordered_map}}
 +
{{dsc inc|cpp/container/dsc insert_range|unordered_map}}
 
{{dsc inc|cpp/container/dsc insert_or_assign|unordered_map}}
 
{{dsc inc|cpp/container/dsc insert_or_assign|unordered_map}}
 
{{dsc inc|cpp/container/dsc emplace|unordered_map}}
 
{{dsc inc|cpp/container/dsc emplace|unordered_map}}
Line 142: Line 146:
 
{{dsc end}}
 
{{dsc end}}
  
−
===[[cpp/container/unordered_map/deduction_guides|Deduction guides]]{{mark since c++17}}===
+
{{rrev|since=c++17|
 +
==={{rl|deduction guides|Deduction guides}}===
 +
}}
 +
 
 +
===Notes===
 +
{{ftm begin|std=1|comment=1}}
 +
{{ftm|__cpp_lib_containers_ranges|value=202202L|std=C++23|Ranges construction and insertion for containers}}
 +
{{ftm end}}
  
 
===Example===
 
===Example===
 
{{example
 
{{example
−
|
 
 
|code=
 
|code=
 
#include <iostream>
 
#include <iostream>
Line 155: Line 165:
 
{
 
{
 
     // Create an unordered_map of three strings (that map to strings)
 
     // Create an unordered_map of three strings (that map to strings)
−
     std::unordered_map<std::string, std::string> u = {
+
     std::unordered_map<std::string, std::string> u =
−
         {"RED","#FF0000"},
+
    {
−
         {"GREEN","#00FF00"},
+
         {"RED", "#FF0000"},
−
         {"BLUE","#0000FF"}
+
         {"GREEN", "#00FF00"},
 +
         {"BLUE", "#0000FF"}
 
     };
 
     };
−
 
+
   
 
     // Helper lambda function to print key-value pairs
 
     // Helper lambda function to print key-value pairs
 
     auto print_key_value = [](const auto& key, const auto& value)
 
     auto print_key_value = [](const auto& key, const auto& value)
Line 166: Line 177:
 
         std::cout << "Key:[" << key << "] Value:[" << value << "]\n";
 
         std::cout << "Key:[" << key << "] Value:[" << value << "]\n";
 
     };
 
     };
−
 
+
   
 
     std::cout << "Iterate and print key-value pairs of unordered_map, being\n"
 
     std::cout << "Iterate and print key-value pairs of unordered_map, being\n"
 
                 "explicit with their types:\n";
 
                 "explicit with their types:\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);
−
 
+
   
 
     std::cout << "\nIterate and print key-value pairs using C++17 structured binding:\n";
 
     std::cout << "\nIterate and print key-value pairs using C++17 structured binding:\n";
−
     for( const auto& [key, value] : u )
+
     for (const auto& [key, value] : u)
 
         print_key_value(key, value);
 
         print_key_value(key, value);
−
 
+
   
 
     // Add two new entries to the unordered_map
 
     // Add two new entries to the unordered_map
 
     u["BLACK"] = "#000000";
 
     u["BLACK"] = "#000000";
 
     u["WHITE"] = "#FFFFFF";
 
     u["WHITE"] = "#FFFFFF";
−
 
+
   
 
     std::cout << "\nOutput values by key:\n"
 
     std::cout << "\nOutput values by key:\n"
 
                 "The HEX of color RED is:[" << u["RED"] << "]\n"
 
                 "The HEX of color RED is:[" << u["RED"] << "]\n"
 
                 "The HEX of color BLACK is:[" << u["BLACK"] << "]\n\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";
 
     std::cout << "Use operator[] with non-existent key to insert a new key-value pair:\n";
 
     print_key_value("new_key", u["new_key"]);
 
     print_key_value("new_key", u["new_key"]);
−
 
+
   
 
     std::cout << "\nIterate and print key-value pairs, using `auto`;\n"
 
     std::cout << "\nIterate and print key-value pairs, using `auto`;\n"
 
                 "new_key is now one of the keys in the map:\n";
 
                 "new_key is now one of the keys in the map:\n";
−
     for( const auto& n : u )
+
     for (const auto& n : u)
 
         print_key_value(n.first, n.second);
 
         print_key_value(n.first, n.second);
 
}
 
}
−
|p=true <!--the order of elements is not specified-->
+
|p=true<!--the order of elements is not specified-->
 
|output=
 
|output=
 
Iterate and print key-value pairs of unordered_map, being
 
Iterate and print key-value pairs of unordered_map, being
Line 221: Line 232:
 
Key:[RED] Value:[#FF0000]
 
Key:[RED] Value:[#FF0000]
 
}}
 
}}
 +
 +
===Defect reports===
 +
{{dr list begin}}
 +
{{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===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
 +
{{dsc inc|cpp/container/dsc unordered_multimap}}
 
{{dsc inc|cpp/container/dsc map}}
 
{{dsc inc|cpp/container/dsc map}}
 +
{{dsc inc|cpp/container/dsc flat_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}}

Latest revision as of 15:45, 1 November 2024

 
C++
 
Containers library
 
std::unordered_map
Member types
Member functions
Non-member functions
(until C++20)
Deduction guides(C++17)
 
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_map;
 (1) (since C++11)
namespace pmr {

    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>>>;

}
 (2) (since C++17)

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 exact bucket the element is placed into.

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.

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

This section is incomplete
Reason: Add descriptions of the template parameters.

[edit] Member types

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]
insert_return_type (since C++17) type describing the result of inserting a node_type, a specialization of

template<class Iter, class NodeType>
struct /*unspecified*/
{
    Iter     position;
    bool     inserted;
    NodeType node;
};
instantiated with template arguments iterator and node_type.[edit]

[edit] Member functions

 constructs the unordered_map
(public member function) [edit]
destructs the unordered_map
(public member function) [edit]
assigns values to the container
(public member function) [edit]
returns the associated allocator
(public member function) [edit]
Iterators
returns an iterator to the beginning
(public member function) [edit]
returns an 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 elements or nodes(since C++17)
(public member function) [edit]
(C++23)
 inserts a range of elements
(public member function) [edit]
(C++17)
 inserts an element or assigns to the current element if the key already exists
(public member function) [edit]
constructs element in-place
(public member function) [edit]
constructs elements in-place using a hint
(public member function) [edit]
(C++17)
 inserts in-place if the key does not exist, does nothing if the key exists
(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
access specified element with bounds checking
(public member function) [edit]
access or insert specified element
(public member function) [edit]
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]
Bucket interface
returns an iterator to the beginning of the specified bucket
(public member function) [edit]
returns an iterator to the end of the specified bucket
(public member function) [edit]
returns the number of buckets
(public member function) [edit]
returns the maximum number of buckets
(public member function) [edit]
returns the number of elements in specific bucket
(public member function) [edit]
returns the bucket for specific key
(public member function) [edit]
Hash policy
returns average number of elements per bucket
(public member function) [edit]
manages maximum average number of elements per bucket
(public member function) [edit]
reserves at least the specified number of buckets and regenerates the hash table
(public member function) [edit]
reserves space for at least the specified number of elements and regenerates the hash table
(public member function) [edit]
Observers
returns function used to hash the keys
(public member function) [edit]
returns the function used to compare keys for equality
(public member function) [edit]

[edit] Non-member functions

(C++11)(C++11)(removed in C++20)
 compares the values in the unordered_map
(function template) [edit]
(C++11)
 specializes the std::swap algorithm
(function template) [edit]
(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

Run this code
#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 and
std::allocator_traits

[edit] See also

(C++11)
 collection of key-value pairs, hashed by keys
(class template) [edit]
collection of key-value pairs, sorted by keys, keys are unique
(class template) [edit]
(C++23)
 adapts two containers to provide a collection of key-value pairs, sorted by unique keys
(class template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/container/unordered_map&oldid=177451"