std::flat_map

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

技术规范

符号索引

外部库

 

容器库

序列

array (C++11)

vector

vector<bool>

inplace_vector (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::flat_map

成员类型
成员函数
flat_map::flat_map	flat_map::operator=
元素访问
flat_map::at	flat_map::operator[]
迭代器
flat_map::beginflat_map::cbegin flat_map::endflat_map::cend	flat_map::rbeginflat_map::crbegin flat_map::rendflat_map::crend
容量
flat_map::size flat_map::max_size	flat_map::empty
修改器
flat_map::clear flat_map::erase flat_map::swap flat_map::emplace flat_map::extract flat_map::replace	flat_map::insert flat_map::insert_range flat_map::insert_or_assign flat_map::emplace_hint flat_map::try_emplace
查找
flat_map::count flat_map::find flat_map::contains	flat_map::equal_range flat_map::lower_bound flat_map::upper_bound
观察器
flat_map::key_comp flat_map::keys	flat_map::value_comp flat_map::values
非成员函数
operator==operator<=> (C++23)(C++23)	swap(std::flat_map) (C++23) erase_if(std::flat_map) (C++23)
辅助类
uses_allocator<std::flat_map> (C++23)
标签
sorted_unique (C++23)	sorted_unique_t (C++23)
推导指引

 

在标头 <flat_map> 定义
template<     class Key,     class T,     class Compare = std::less<Key>,     class KeyContainer = std::vector<Key>,     class MappedContainer = std::vector<T> > class flat_map;		(C++23 起)

平铺映射（flat map）是一种容器适配器，给出具有唯一键的包含键-值对的关联容器的功能。用比较函数 Compare 来对键进行排序。

类模板 flat_map 表现为对分别作为 KeyContainer 和 MappedContainer 类型的对象而传递的底层容器的包装器。第一个容器有序，且每个键的对应值在第二个容器中处于相同索引（偏移量）。两个容器的元素数量相同。

每当标准库使用比较 (Compare) 的要求，都使用等价关系来确定唯一性。非正式而言，如果两个对象 a 和 b 中没有任何一个比较小于另一个，则认为它们等价：!comp(a, b) && !comp(b, a)。

std::flat_map 满足容器 (Container) 、可逆容器 (ReversibleContainer) 的要求，可选容器要求，以及所有关联容器 (AssociativeContainer) 的要求（包括对数阶的搜索复杂度），但：

• 不适用节点相关要求，
• 迭代器失效的要求有所不同，
• 插入和擦除操作的复杂度呈线性。

平铺映射支持关联容器 (AssociativeContainer) 的大多数使用唯一键的操作。

模板形参

Key	-	键的类型。如果 Key 与 KeyContainer::value_type 不是同一类型则程序非良构。
T	-	被映射值的类型。如果 T 与 MappedContainer::value_type 不是同一类型则程序非良构。
Compare	-	一种提供严格弱序的比较 (Compare) 类型。
KeyContainer MappedContainer	-	用以分别存储键和被映射值的底层序列容器 (SequenceContainer) 的类型。这种容器的迭代器应当满足老式随机访问迭代器 (LegacyRandomAccessIterator) 或实现 random_access_iterator。其成员函数 size 和 max_size 的调用不能以异常退出。 标准容器 std::vector 和 std::deque 均满足这些要求。

成员类型

成员类型	定义
key_container_type	KeyContainer
mapped_container_type	MappedContainer
key_type	Key
mapped_type	T
value_type	std::pair<key_type, mapped_type>
key_compare	Compare
reference	std::pair<const key_type&, mapped_type&>
const_reference	std::pair<const key_type&, const mapped_type&>
size_type	std::size_t
difference_type	std::ptrdiff_t
iterator	由实现定义的指向 value_type 的老式输入迭代器 (LegacyInputIterator) 和 random_access_iterator
const_iterator	由实现定义的指向 const value_type 的老式输入迭代器 (LegacyInputIterator) 和 random_access_iterator
reverse_iterator	std::reverse_iterator<iterator>
const_reverse_iterator	std::reverse_iterator<const_iterator>
containers	描述底层容器的类型 struct containers {     key_container_type keys;     mapped_container_type values; };

成员类

value_compare

比较 value_type 类型的对象 (类)

成员对象

成员名称	定义
c (私有)	containers 类型的对象 (仅用于阐述的成员对象*)
compare (私有)	key_compare 类型的比较函数对象 (仅用于阐述的成员对象*)

成员函数

(构造函数)	构造 flat_map (公开成员函数)
(析构函数) (隐式声明)	销毁容器适配器的每个元素 (公开成员函数)
operator=	将值赋给容器适配器 (公开成员函数)
元素访问
at	带越界检查访问指定的元素 (公开成员函数)
operator[]	访问或插入指定的元素 (公开成员函数)
迭代器
begincbegin	返回指向起始的迭代器 (公开成员函数)
endcend	返回指向末尾的迭代器 (公开成员函数)
rbegincrbegin	返回指向起始的逆向迭代器 (公开成员函数)
rendcrend	返回指向末尾的逆向迭代器 (公开成员函数)
容量
empty	检查容器适配器是否为空 (公开成员函数)
size	返回元素数 (公开成员函数)
max_size	返回可容纳的最大元素数 (公开成员函数)
修改器
emplace	原位构造元素 (公开成员函数)
emplace_hint	使用提示原位构造元素 (公开成员函数)
try_emplace	若键不存在则原位插入，若键存在则不做任何事 (公开成员函数)
insert	插入元素 (公开成员函数)
insert_range	插入一个元素范围 (公开成员函数)
insert_or_assign	插入元素，或若键已存在则赋值给当前元素 (公开成员函数)
extract	提取底层容器 (公开成员函数)
replace	替换底层各容器 (公开成员函数)
erase	擦除元素 (公开成员函数)
swap	交换内容 (公开成员函数)
clear	清除内容 (公开成员函数)
查找
find	寻找带有特定键的元素 (公开成员函数)
count	返回匹配特定键的元素数量 (公开成员函数)
contains	检查容器是否含有带特定键的元素 (公开成员函数)
lower_bound	返回指向首个不小于给定键的元素的迭代器 (公开成员函数)
upper_bound	返回指向首个大于给定键的元素的迭代器 (公开成员函数)
equal_range	返回匹配特定键的元素范围 (公开成员函数)
观察器
key_comp	返回用于比较键的函数 (公开成员函数)
value_comp	返回用于比较 value_type 类型的对象中的键的函数 (公开成员函数)
keys	直接访问底层键容器 (公开成员函数)
values	直接访问底层值容器 (公开成员函数)

非成员函数

operator==operator<=> (C++23)	按照字典顺序比较两个 flat_map 的值 (函数模板)
std::swap(std::flat_map) (C++23)	特化 std::swap 算法 (函数模板)
erase_if(std::flat_map) (C++23)	擦除所有满足特定判别标准的元素 (函数模板)

辅助类

std::uses_allocator<std::flat_map> (C++11)

特化 std::uses_allocator 类型特征 (类模板特化)

标签

sorted_uniquesorted_unique_t (C++23)

指出范围的元素有序且唯一 (标签)

注解

成员类型 iterator 与 const_iterator 可能是同一类型的别名。这表明以这两个类型为形参类型的一对函数重载可能违背单一定义规则。因为 iterator 可转换到 const_iterator，所以可以改成只提供一个以 const_iterator 为形参类型的函数。

功能特性测试宏	值	标准	功能特性
__cpp_lib_flat_map	202207L	(C++23)	std::flat_map 和 std::flat_multimap

参阅

flat_multimap (C++23)	适配两个容器以提供按键排序的键值对集合 (类模板)
map	键值对的集合，按照键排序，键是唯一的 (类模板)
unordered_map (C++11 起)	键值对的集合，按照键生成散列，键是唯一的 (类模板)