命名空间
变体
操作

std::flat_map

来自 cppreference.cn
< cpp‎ | 容器
 
C++
 
容器库
 
std::flat_map
成员类型
成员函数
非成员函数
辅助类
标签
推导指引
 
在头文件 <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的所有要求（包括对数搜索复杂度），除了：

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

flat map 支持大多数使用唯一键的关联容器操作。

std::flat_map 的所有成员函数都是 constexpr：可以在常量表达式的求值中创建和使用 std::flat_map 对象。

然而，std::flat_map 对象通常不能是 constexpr，因为任何动态分配的存储都必须在同一常量表达式的求值中释放。

 (C++26 起)

目录

[编辑] 迭代器失效

本节不完整

[编辑] 模板参数

Key - 键的类型。如果 Key 的类型与 KeyContainer::value_type 不同，则程序格式错误。
T - 映射值的类型。如果 T 的类型与 MappedContainer::value_type 不同，则程序格式错误。
Compare - 提供严格弱排序的 Compare 类型。
KeyContainer
MappedContainer		 - 用于分别存储键和映射值的底层序列容器的类型。此类容器的迭代器应满足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 实现定义的LegacyInputIterator，ConstexprIterator(从 C++26 开始)和random_access_iterator到value_type[编辑]
const_iterator 实现定义的LegacyInputIterator，ConstexprIterator(从 C++26 开始)和random_access_iterator到const value_type[编辑]
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_type 类型的对象
(类) [编辑]

[编辑] 成员对象

成员 描述
containers c (私有) 被适配的容器
(仅用于阐释的成员对象*)
key_compare compare (私有) 比较函数对象
(仅用于阐释的成员对象*)

[编辑] 成员函数

 构造 flat_map
(公共成员函数) [编辑]
(析构函数)
(隐式声明)
 销毁容器适配器的每个元素
(公开成员函数)
向容器适配器赋值
(公共成员函数) [编辑]
元素访问
 访问指定的元素，带边界检查
(公共成员函数) [编辑]
 访问或插入指定元素
(公共成员函数) [编辑]
迭代器
 返回指向起始的迭代器
(公共成员函数) [编辑]
 返回指向末尾的迭代器
(公共成员函数) [编辑]
 返回指向起始的逆向迭代器
(公共成员函数) [编辑]
 返回指向末尾的逆向迭代器
(公共成员函数) [编辑]
容量
 检查容器适配器是否为空
(公共成员函数) [编辑]
 返回元素数量
(公共成员函数) [编辑]
 返回元素的最大可能数量
(公共成员函数) [编辑]
修改器
 就地构造元素
(公共成员函数) [编辑]
 使用提示就地构造元素
(公共成员函数) [编辑]
 如果键不存在则原地插入，如果键存在则不执行任何操作
(公共成员函数) [编辑]
 插入元素
(公共成员函数) [编辑]
 插入元素范围
(公共成员函数) [编辑]
 插入元素或如果键已存在则赋值给当前元素
(公共成员函数) [编辑]
 提取底层容器
(公共成员函数) [编辑]
 替换底层容器
(公共成员函数) [编辑]
 擦除元素
(公共成员函数) [编辑]
 交换内容
(公共成员函数) [编辑]
 清除内容
(公共成员函数) [编辑]
查找
 查找具有特定键的元素
(公共成员函数) [编辑]
 返回匹配特定键的元素数量
(公共成员函数) [编辑]
 检查容器是否包含具有特定键的元素
(公共成员函数) [编辑]
 返回指向第一个不小于给定键的元素的迭代器
(公共成员函数) [编辑]
 返回指向第一个大于给定键的元素的迭代器
(公共成员函数) [编辑]
 返回与特定键匹配的元素范围
(公共成员函数) [编辑]
观察器
 返回比较键的函数
(公共成员函数) [编辑]
 返回比较 value_type 类型对象中的键的函数
(公共成员函数) [编辑]
 直接访问底层键容器
(公共成员函数) [编辑]
 直接访问底层值容器
(公共成员函数) [编辑]

[编辑] 非成员函数

(C++23)
 按字典序比较两个 flat_map 的值
(函数模板) [编辑]
(C++23)
 特化 std::swap 算法
(函数模板) [编辑]
(C++23)
 擦除所有满足特定标准的元素
(函数模板) [编辑]

[编辑] 辅助类

(C++23)
 特化 std::uses_allocator 类型特性
(类模板特化) [编辑]

[编辑] 标签

(C++23)
 表示范围的元素已排序且唯一
(标签)[编辑]

[编辑] 推导指南

[编辑] 注解

成员类型 iterator 和 const_iterator 可以是相同类型的别名。这意味着使用这两种类型作为参数类型定义一对函数重载可能会违反单一定义规则。由于 iterator 可以转换为 const_iterator，因此使用 const_iterator 作为参数类型的单个函数将代替工作。


特性测试宏 值 标准 特性
__cpp_lib_flat_map 202207L (C++23) std::flat_map 和 std::flat_multimap
__cpp_lib_constexpr_containers 202502L (C++26) constexpr std::flat_map

[编辑] 示例

本节不完整
原因：无示例

[编辑] 另请参阅

(C++23)
 适配两个容器以提供按键排序的键值对集合
(类模板) [编辑]
 键值对集合，按键排序，键唯一
(类模板) [编辑]
(C++11)
 键值对的集合，按键哈希，键是唯一的
(类模板) [编辑]
取自 "https://cppreference.cn/mwiki/index.php?title=cpp/container/flat_map&oldid=180917"