std::unordered_map

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

容器库

序列

数组 (C++11)

向量

向量<bool>

就地向量 (C++26)

双端队列

前向列表 (C++11)

列表

关联

集合

多重集合

映射

多重映射

无序关联

无序集合 (C++11)

无序多重集合 (C++11)

无序映射 (C++11)

无序多重映射 (C++11)

适配器

栈

队列

优先队列

扁平集合 (C++23)

扁平多重集合 (C++23)

扁平映射 (C++23)

扁平多重映射 (C++23)

视图

跨度 (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::swap	从不
清除，重新哈希，保留，运算符=	总是
插入，放置，放置提示，运算符[]	只有在导致重新哈希时
擦除	仅擦除元素

注意

• 交换函数不会使容器内的任何迭代器失效，但它们会使标记交换区域末尾的迭代器失效。

• 即使对应的迭代器失效，对存储在容器中的键或数据的引用和指针也只会被擦除该元素所使失效。

成员类型

成员类型	定义
key_type	Key
mapped_type	T
value_type	std::pair<const Key, T>
size_type	无符号整数类型（通常为 std::size_t)
difference_type	带符号整数类型（通常为 std::ptrdiff_t）
哈希函数	Hash
键比较函数	KeyEqual
分配器类型	Allocator
引用	value_type&
常量引用	const value_type&
指针	std::allocator_traits<Allocator>::pointer
常量指针	std::allocator_traits<Allocator>::const_pointer
迭代器	LegacyForwardIterator 到 value_type
常量迭代器	LegacyForwardIterator 到 const value_type
本地迭代器	一种迭代器类型，其类别、值、差值、指针和 引用类型与 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 (公有成员函数)
运算符=	将值分配给容器 (公有成员函数)
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)	如果键不存在，则在容器中就地构造元素，如果键存在，则不执行任何操作 (公有成员函数)
擦除	擦除元素 (公有成员函数)
swap	交换容器的内容 (公有成员函数)
extract (C++17)	从容器中提取节点 (公有成员函数)
merge (C++17)	从另一个容器中拼接节点 (公有成员函数)
查找
at	访问指定元素，并进行边界检查 (公有成员函数)
运算符[]	访问或插入指定元素 (公有成员函数)
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 中已移除)	比较无序映射中的值 (函数模板)
std::swap(std::unordered_map) (C++11)	专门化 std::swap 算法 (函数模板)
erase_if(std::unordered_map) (C++20)	擦除满足特定条件的所有元素 (函数模板)

推断指南	(自 C++17 起)

备注

特性测试 宏	值	Std	特性
__cpp_lib_containers_ranges	202202L	(C++23)	容器的范围构造和插入

示例

运行此代码

#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

另请参见

无序多重映射 (C++11)	键值对集合，按键进行哈希处理 (类模板)
映射	键值对集合，按键排序，键是唯一的 (类模板)
扁平映射 (C++23)	适配两个容器以提供键值对集合，按唯一键排序 (类模板)