C++ STL容器之unordered_map

C++ unordered_map 容器

定义于头文件 之中，申明为：

template<
    class Key,
    class T,
    class Hash = std::hash,
    class KeyEqual = std::equal_to,
    class Allocator = std::allocator< std::pair >
> class unordered_map;

unordered_map 是关联容器，含有带唯一键的键-值 pair 。搜索、插入和元素移除拥有平均常数时间复杂度。

元素在内部不以任何特定顺序排序，而是组织进桶中。元素放进哪个桶完全依赖于其键的哈希。这允许对单独元素的快速访问，因为一旦计算哈希，则它准确指代元素所放进的桶。

std::unordered_map 满足容器 (Container) 、具分配器容器 (AllocatorAwareContainer) 、无序关联容器 (UnorderedAssociativeContainer) 的要求。
$注：$unordered_map 与 map的最大区别就是前者并不排序，后者容器内部会自动排序。

成员类型

成员类型	定义
key_type	Key
mapped_type	T
value_type	std::pair
size_type	无符号整数类型（通常是 std::size_t ）
difference_type	有符号整数类型（通常是 std::ptrdiff_t ）
hasher	Hash
key_equal	KeyEqual(C++20 前) Hash::transparent_key_equal ，若定义且它指名类型，否则为 KeyEqual(C++20 起)
allocator_type	Allocator
reference	value_type&
const_reference	const value_type&
pointer	std::allocator_traits::pointer
const_pointer	std::allocator_traits::const_pointer
iterator	向前迭代器 (LegacyForwardIterator)
const_iterator	常向前迭代器
local_iterator	类别、值、差、指针和引用类型都与 iterator 相同的迭代器类型。能用此迭代器在单个桶迭代，但不能跨桶。
const_local_iterator	类别、值、差、指针和引用类型都与 const_iterator 相同的迭代器类型。能用此迭代器在单个桶迭代，但不能跨桶。
node_type(C++17 起	表示容器结点的结点把柄特化
insert_return_type(C++17 起)	描述插入 node_type 结果的类型，下列类型的特化

成员函数

(构造函数)	构造 unordered_map (公开成员函数)
(析构函数)	析构 unordered_map (公开成员函数)
operator=	赋值给容器 (公开成员函数)
get_allocator	返回相关的分配器 (公开成员函数)

迭代器

begin、cbegin	返回指向容器第一个元素的迭代器 (公开成员函数)
end、cend	返回指向容器尾端的迭代器 (公开成员函数)

示例：

#include
#include
using namespace std;

int main() {
	unordered_map<int, int> myUnorderedMap = { {2, 10},{1, 20},{3,30} };
	//正向迭代器测试
	cout << "正向迭代器遍历容器：";
	for (auto it = myUnorderedMap.begin(); it != myUnorderedMap.end(); ++it) {
		cout << it->first << " -> " << it->second << ", ";
	}
	cout << endl;
	//正向常迭代器测试
	cout << "正向常迭代器遍历容器：";
	for (auto cit = myUnorderedMap.cbegin(); cit != myUnorderedMap.cend(); ++cit) {
		cout << cit->first << " -> " << cit->second << ", ";
	}
	cout << endl;
	return 0;
}

容量

empty	检查容器是否为空 (公开成员函数)
size	返回容纳的元素数 (公开成员函数)
max_size	返回可容纳的最大元素数 (公开成员函数)

示例：

#include
#include
using namespace std;

int main() {
	unordered_map<int, int> myUnorderedMap = { {2, 10},{1, 20},{3,30} };
	cout << "myUnorderedMap.empty() = " << myUnorderedMap.empty() << endl;
	cout << "myUnorderedMap.size() = " << myUnorderedMap.size() << endl;
	cout << "myUnorderedMap.max_size() = " << myUnorderedMap.max_size() << endl;
	return 0;
}

修改器

clear	清除内容 (公开成员函数)
insert	插入元素或结点 (C++17 起) (公开成员函数)
insert_or_assign(C++17)	插入元素，或若关键已存在则赋值给当前元素 (公开成员函数)
emplace	原位构造元素 (公开成员函数)
emplace_hint	使用提示原位构造元素 (公开成员函数)
try_emplace (C++17)	若键不存在则原位插入，若键存在则不做任何事 (公开成员函数)
erase	擦除元素 (公开成员函数)
swap	交换内容 (公开成员函数)
extract (C++17)	从另一容器释出结点 (公开成员函数)
merge (C++17)	从另一容器接合结点 (公开成员函数)

示例：

#include
#include
using namespace std;

int main() {
	unordered_map<int, int> myUnorderedMap = { {2, 10},{1, 20},{3,30} };
	cout << "键值对序列：" << endl;
	for (auto &item : myUnorderedMap) {
		cout << item.first << " -> " << item.second << endl;
	}
	//插入元素
	myUnorderedMap.insert({ 0, 100 });
	cout << "插入 （0, 100）键值对后：" << endl;
	for (auto &item : myUnorderedMap) {
		cout << item.first << " -> " << item.second << endl;
	}
	//按key删除元素
	myUnorderedMap.erase(0);
	cout << "移除0对应的键值对后：" << endl;
	for (auto &item : myUnorderedMap) {
		cout << item.first << " -> " << item.second << endl;
	}
	//按迭代器删除元素
	myUnorderedMap.erase(myUnorderedMap.begin());
	cout << "移除map中第一个键值对后：" << endl;
	for (auto &item : myUnorderedMap) {
		cout << item.first << " -> " << item.second << endl;
	}
	//清空map
	myUnorderedMap.clear();
	cout << "清空map后：" << endl;
	for (auto &item : myUnorderedMap) {
		cout << item.first << " -> " << item.second << endl;
	}
	return 0;
}

查找

at	访问指定的元素，同时进行越界检查 (公开成员函数)
operator[]	访问或插入指定的元素 (公开成员函数)
count	返回匹配特定键的元素数量 (公开成员函数)
find	寻找带有特定键的元素 (公开成员函数)
contains (C++20)	检查容器是否含有带特定关键的元素 (公开成员函数)
equal_range	返回匹配特定键的元素范围 (公开成员函数)

示例：

#include
#include
using namespace std;

int main() {
	unordered_map<int, int> myUnorderedMap = { {2, 10},{1, 20},{3,30} };
	cout << "键值对序列：" << endl;
	for (auto &item : myUnorderedMap) {
		cout << item.first << " -> " << item.second << endl;
	}
	cout << "myUnorderedMap.[2] = " << myUnorderedMap[2] << endl;
	cout << "myUnorderedMap.count(1) = " << myUnorderedMap.count(1) << endl;
	cout << "myUnorderedMap.find(2) == myUnorderedMap.end() ? " << (myUnorderedMap.find(2) == myUnorderedMap.end()) << endl;
	//寻找键为2的值
	cout << "键 == 2 对应的值：";
	pair<unordered_map<int, int>::iterator, unordered_map<int, int>::iterator> myRange;
	myRange = myUnorderedMap.equal_range(2);
	for (auto it = myRange.first; it != myRange.second; ++it) {
		cout << it->first << " -> " << it->second << endl;
	}
	cout << "由于unordered_map中具有去重特性，元素具有唯一性，所以每个key只能对应一个val！" << endl;
	return 0;
}

桶接口

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	返回用于比较键的相等性的函数 (公开成员函数)