std::unordered_map

 

C++

編譯器支援

獨立式與託管式

語言

標準函式庫

標準函式庫標頭檔

具名要求

特性測試巨集 (C++20)

語言支援函式庫

概念函式庫 (C++20)

診斷函式庫

記憶體管理函式庫

元編程函式庫 (C++11)

通用公用程式函式庫

容器函式庫

疊代器函式庫

Ranges 函式庫 (C++20)

演算法函式庫

字串函式庫

文本處理函式庫

數值函式庫

日期與時間函式庫

輸入/輸出函式庫

檔案系統函式庫 (C++17)

並行支援函式庫 (C++11)

執行控制函式庫 (C++26)

技術規範

符號索引

外部函式庫

 

容器函式庫

序列

array (C++11)

vector

vector<bool>

inplace_vector (C++26)

hive (C++26)

deque

forward_list (C++11)

list

關聯

set

multiset

map

multimap

無序關聯

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

適配器 (Adaptors)

stack

queue

priority_queue

flat_set (C++23)

flat_multiset (C++23)

flat_map (C++23)

flat_multimap (C++23)

檢視

span (C++20)

mdspan (C++23)

表格

迭代器失效

成員函式表

非成員函式表

 

std::unordered_map

成員型別
成員函式
unordered_map::unordered_map unordered_map::~unordered_map unordered_map::operator= unordered_map::get_allocator 迭代器 unordered_map::beginunordered_map::cbegin unordered_map::endunordered_map::cend 容量 unordered_map::size unordered_map::max_size unordered_map::empty 修改器 unordered_map::clear unordered_map::erase unordered_map::swap unordered_map::extract (C++17) unordered_map::merge (C++17) unordered_map::insert unordered_map::insert_range (C++23) unordered_map::insert_or_assign (C++17)   unordered_map::emplace unordered_map::emplace_hint unordered_map::try_emplace (C++17)	查找 unordered_map::at unordered_map::operator[] unordered_map::count unordered_map::find unordered_map::contains (C++20) unordered_map::equal_range Bucket 介面 unordered_map::begin(size_type)unordered_map::cbegin(size_type) unordered_map::end(size_type)unordered_map::cend(size_type) unordered_map::bucket_count unordered_map::max_bucket_count unordered_map::bucket_size unordered_map::bucket 雜湊策略 (Hash policy) unordered_map::load_factor unordered_map::max_load_factor unordered_map::rehash unordered_map::reserve 觀察器 unordered_map::hash_function unordered_map::key_eq
非成員函式
operator==operator!= (C++20 前)	std::swap(std::unordered_map) erase_if(std::unordered_map) (C++20)
推導指引(C++17)

 

定義於標頭檔 <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)	（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)	(自 C++17 起)

std::unordered_map 是一種關聯式容器，包含具有唯一鍵（key）的鍵值對（key-value pairs）。元素的搜尋、插入與刪除具有平均常數時間複雜度。

在內部，元素不會以任何特定順序排序，而是組織成桶（buckets）。元素被放置在哪個桶中，完全取決於其鍵的雜湊值。具有相同雜湊碼的鍵會出現在同一個桶中。這使得個別元素的存取速度很快，因為一旦計算出雜湊值，它就直接指向元素所在的桶。

如果對映射（map）的鍵相等性謂詞傳入兩個鍵時返回 true，則這兩個鍵被視為等價（equivalent）。如果兩個鍵等價，雜湊函數必須為這兩個鍵返回相同的值。

std::unordered_map 符合 容器 (Container)、分配器感知容器 (AllocatorAwareContainer) 與 無序關聯式容器 (UnorderedAssociativeContainer) 的要求。

std::unordered_map 的所有成員函數皆為 constexpr：這表示可以在常數表達式的求值中建立並使用 std::unordered_map 物件。 然而，std::unordered_map 物件通常不能是 constexpr，因為任何動態配置的儲存空間都必須在同一個常數表達式求值中被釋放。

（C++26 起）

迭代器失效

作業 (Operations)	失效情況
所有唯讀操作、swap、std::swap	永不
clear、rehash、reserve、operator=	總是
insert、emplace、emplace_hint、operator[]	僅當導致重雜湊（rehash）時
erase	僅針對被刪除的元素

註解

• 交換（swap）函數不會使容器內的任何迭代器失效，但它們會使標示交換區域末端的迭代器失效。

• 指向儲存在容器中之鍵或資料的參照與指標，僅在該元素被刪除時才會失效，即使對應的迭代器已經失效亦然。

成員類型

類型	定義
key_type	Key
mapped_type	T
value_type	std::pair<const Key, T>
size_type	無號整數型別（通常為 std::size_t）
difference_type	有號整數型別（通常為 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 與 ConstexprIterator(自 C++26) 至 value_type
const_iterator	LegacyForwardIterator 與 ConstexprIterator(自 C++26) 至 const value_type
local_iterator	一種迭代器類型，其類別、值、差異、指標和 參考類型與 iterator 相同。此迭代器 可用於遍歷單個桶，但不能跨桶遍歷
const_local_iterator	一種迭代器類型，其類別、值、差異、指標和 參考類型與 const_iterator 相同。此迭代器 可用於遍歷單個桶，但不能跨桶遍歷
node_type (C++17 起)	代表容器節點的 節點控制代碼 (node handle) 特化版本
insert_return_type (C++17 起)	描述插入 node_type 結果的型別，為下列型別的特化： template<class Iter, class NodeType> struct /*未指定*/ {     Iter     position;     bool     inserted;     NodeType node; }; 使用範本引數 iterator 與 node_type 實例化。

成員函數

(建構子)	建構 unordered_map (公開成員函式)
(解構函式)	解構 unordered_map (公開成員函式)
operator=	指派值給容器 (公開成員函式)
get_allocator	回傳關聯的配置器 (公開成員函式)
迭代器
begincbegin	回傳指向起點的反覆器 (公開成員函式)
endcend	回傳指向終點的反覆器 (公開成員函式)
容量
empty	檢查容器是否為空 (公開成員函式)
size	回傳元素個數 (公開成員函式)
max_size	回傳最大可能的元素個數 (公開成員函式)
修改器
clear	清除內容 (公開成員函式)
insert	插入元素 或節點(C++17 起) (公開成員函式)
insert_range (C++23)	插入數值範圍元素 (公開成員函式)
insert_or_assign (C++17)	插入元素，若鍵已存在則指派給現有元素 (公開成員函式)
emplace	原地建構元素 (公開成員函式)
emplace_hint	使用提示（hint）原地建構元素 (公開成員函式)
try_emplace (C++17)	若鍵不存在則原地插入；若鍵已存在則不執行任何操作 (公開成員函式)
erase	刪除元素 (公開成員函式)
swap	交換內容 (公開成員函式)
extract (C++17)	從容器中提取節點 (公開成員函式)
merge (C++17)	從另一個容器接合（splice）節點 (公開成員函式)
查找
at	存取指定元素，並進行邊界檢查 (公開成員函式)
operator[]	存取或插入指定元素 (公開成員函式)
count	回傳符合指定鍵的元素數量 (公開成員函式)
find	尋找具有指定鍵的元素 (公開成員函式)
contains (C++20)	檢查容器是否包含具有指定鍵的元素 (公開成員函式)
equal_range	回傳與特定鍵相匹配的元素範圍 (公開成員函式)
Bucket 介面
begin(size_type)cbegin(size_type)	返回指向指定桶開頭的迭代器 (公開成員函式)
end(size_type)cend(size_type)	返回指向指定桶結尾的迭代器 (公開成員函式)
bucket_count	返回桶的數量 (公開成員函式)
max_bucket_count	返回桶的最大數量 (公開成員函式)
bucket_size	返回特定桶中的元素數量 (公開成員函式)
bucket	返回特定鍵所屬的桶索引 (公開成員函式)
雜湊策略 (Hash policy)
load_factor	返回每個桶的平均元素數量 (公開成員函式)
max_load_factor	管理每個桶的最大平均元素數量 (公開成員函式)
rehash	預留至少指定數量的桶並重新產生雜湊表 (公開成員函式)
reserve	為至少指定數量的元素預留空間並重新產生雜湊表 (公開成員函式)
觀察器
hash_function	返回用於雜湊鍵的函式 (公開成員函式)
key_eq	返回用於比較鍵是否相等的函式 (公開成員函式)

非成員函數

operator==operator!= (C++11)(C++11)(在 C++20 中移除)	比較 unordered_map 中的值 (函式模板)
std::swap(std::unordered_map) (C++11)	特化 std::swap 演算法 (函式範本)
erase_if(std::unordered_map) (C++20)	移除所有符合特定條件的元素 (函式範本)

推導指引	(自 C++17 起)

註解

功能測試巨集	數值	標準	功能
__cpp_lib_containers_ranges	202202L	(C++23)	容器的範圍建構與插入
__cpp_lib_constexpr_containers	202502L	(C++26)	constexpr std::unordered_map

範例

執行此程式碼

#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);
}

可能輸出

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]

缺陷報告

下列更改行為的缺陷報告追溯應用於之前的 C++ 標準。

DR	應用於	出版時的行為	正確的行為
LWG 2050	C++11	reference、const_reference、pointer 和 const_pointer 的定義基於 allocator_type	基於 value_type 和 std::allocator_traits

參見

unordered_multimap (C++11)	鍵值對的集合，按鍵雜湊 (類別範本)
map	鍵值對（key-value pairs）的集合，按鍵排序，且鍵是唯一的 (類別樣板)
flat_map (C++23)	適配兩個容器以提供按唯一鍵排序的鍵值對集合 (類別樣板)