std::flat_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::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::count flat_map::find flat_map::contains flat_map::equal_range    flat_map::lower_bound flat_map::upper_bound 容量 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::key_comp flat_map::keys flat_map::value_comp flat_map::values

非成員函式

operator==operator<=>         swap(std::flat_map) erase_if(std::flat_map)

輔助類

uses_allocator<std::flat_map>

標籤

sorted_unique       sorted_unique_t

推導指引

 

在標頭檔案 <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_compare

比較 value_type 型別的物件 (類)

成員物件

成員	描述
containers c (私有)	被適配的容器 (僅用於闡釋的成員物件*)
key_compare 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++23)

特化 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
__cpp_lib_constexpr_containers	202502L	(C++26)	constexpr std::flat_map

另請參閱

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