std::unordered_map

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (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)

介面卡

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 桶介面 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 雜湊策略 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 是一個關聯容器，包含鍵值對，且鍵是唯一的。元素的查詢、插入和刪除具有平均常數時間複雜度。

在內部，元素不按任何特定順序排序，而是組織成桶。元素被放入哪個桶完全取決於其鍵的雜湊值。具有相同雜湊碼的鍵出現在同一個桶中。這允許快速訪問單個元素，因為一旦計算出雜湊值，它就指向元素所在的精確桶。

如果對映的鍵相等謂詞在傳入兩個鍵時返回 true，則兩個鍵被認為是等價的。如果兩個鍵等價，則雜湊函式必須為兩個鍵返回相同的值。

std::unordered_map 滿足 Container、AllocatorAwareContainer、UnorderedAssociativeContainer 的要求。

std::unordered_map 的所有成員函式都是 constexpr：可以在常量表達式的求值中建立和使用 std::unordered_map 物件。 然而，std::unordered_map 物件通常不能是 constexpr，因為任何動態分配的儲存都必須在同一常量表達式的求值中釋放。

(C++26 起)

迭代器失效

操作	失效
所有隻讀操作，swap，std::swap	永不
clear，rehash，reserve，operator=	總是
insert，emplace，emplace_hint，operator[]	僅當導致重新雜湊時
erase	僅對被擦除的元素

注

• 交換函式不會使容器內的任何迭代器失效，但會使標記交換區域末尾的迭代器失效。

• 指向容器中儲存的鍵或資料的引用和指標僅在刪除該元素時失效，即使相應的迭代器失效也是如此。

成員型別

型別	定義
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 起)	節點控制代碼的特化，表示容器節點
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	使用提示就地構造元素 (公共成員函式)
try_emplace (C++17)	如果鍵不存在則原地插入，如果鍵存在則不執行任何操作 (公共成員函式)
erase	擦除元素 (公共成員函式)
swap	交換內容 (公共成員函式)
extract (C++17)	從容器中提取節點 (公共成員函式)
merge (C++17)	從另一個容器拼接節點 (公共成員函式)
查詢
at	訪問指定的元素，帶邊界檢查 (公共成員函式)
operator[]	訪問或插入指定元素 (公共成員函式)
count	返回匹配特定鍵的元素數量 (公共成員函式)
find	查詢具有特定鍵的元素 (公共成員函式)
contains (C++20)	檢查容器是否包含具有特定鍵的元素 (公共成員函式)
equal_range	返回與特定鍵匹配的元素範圍 (公共成員函式)
桶介面
begin(size_type)cbegin(size_type)	返回指向指定桶開頭的迭代器 (公共成員函式)
end(size_type)cend(size_type)	返回指向指定桶末尾的迭代器 (公共成員函式)
bucket_count	返回桶的數量 (公共成員函式)
max_bucket_count	返回最大桶數量 (公共成員函式)
bucket_size	返回特定桶中的元素數量 (公共成員函式)
bucket	返回特定鍵的桶 (公共成員函式)
雜湊策略
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++ 標準。

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

參閱

unordered_multimap (C++11)	鍵值對集合，按鍵雜湊 (類模板)
map	鍵值對集合，按鍵排序，鍵唯一 (類模板)
flat_map (C++23)	適配兩個容器以提供鍵值對集合，按唯一鍵排序 (類模板)