A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://en.cppreference.com/w/cpp/language/../keyword/../container/unordered_map.html below:

std::unordered_map - cppreference.com

(1) (since C++11) (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 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.

All member functions of 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.

(since C++26) [edit] Iterator invalidation [edit] Notes [edit] 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 and ConstexprIterator(since C++26) to value_type[edit] const_iterator LegacyForwardIterator and ConstexprIterator(since C++26) 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] inserts a range of elements
(public member function) [edit] 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] 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] extracts nodes from the container
(public member function) [edit] 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] 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 [edit] Notes [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 and
std::allocator_traits [edit] See also 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] adapts two containers to provide a collection of key-value pairs, sorted by unique keys
(class template) [edit]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4