std::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::map

成員函式

map::map map::~map               map::operator= map::get_allocator

元素訪問 map::at map::operator[] 迭代器 map::beginmap::cbegin (C++11起) map::endmap::cend (C++11起) map::rbeginmap::crbegin (C++11起)      map::rendmap::crend (C++11起) 容量 map::size map::max_size map::empty 觀察器 map::key_comp map::value_comp 修改器 map::clear map::insert map::erase map::swap map::extract (C++17) map::merge (C++17) map::insert_range (C++23) map::insert_or_assign (C++17) map::emplace (C++11) map::emplace_hint (C++11) map::try_emplace (C++17) 查詢 map::count map::find map::contains (C++20) map::equal_range map::lower_bound map::upper_bound

非成員函式

operator==operator<=> (C++20 起) std::swap(std::map) erase_if(std::map) (C++20起)   operator!=operator<operator>operator<=operator>= (C++20前)(C++20前)(C++20前)(C++20前)(C++20前)

推導指引 (C++17)

 

定義於標頭檔案 <map>
template<     class Key,     class T,     class Compare = std::less<Key>,     class Allocator = std::allocator<std::pair<const Key, T>> > class map;	(1)
namespace pmr {     template<         class Key,         class T,         class Compare = std::less<Key>     > using map = std::map<Key, T, Compare,                            std::pmr::polymorphic_allocator<std::pair<const Key, T>>>; }	(2)	(C++17 起)

std::map 是一個有序的關聯容器，包含具有唯一鍵的鍵值對。鍵透過比較函式 Compare 進行排序。搜尋、刪除和插入操作具有對數複雜度。Map 通常實現為紅黑樹。

std::map 的迭代器按鍵的升序迭代，其中升序由用於構造的比較定義。也就是說，給定

• m，一個 std::map
• it_l 和 it_r，指向 m 的可解引用迭代器，且 it_l < it_r。

m.value_comp()(*it_l, *it_r) == true（如果使用預設比較，則從最小到最大）。

在標準庫使用 Compare 要求的所有地方，唯一性都透過等價關係確定。不精確地說，如果兩個物件 a 和 b 都不比對方小，則它們被認為是等價的（不唯一）：!comp(a, b) && !comp(b, a)。

std::map 滿足 Container、AllocatorAwareContainer、AssociativeContainer 和 ReversibleContainer 的要求。

std::map 的所有成員函式都是 constexpr：可以在常量表達式的求值中建立和使用 std::map 物件。 然而，std::map 物件通常不能是 constexpr，因為任何動態分配的儲存都必須在同一常量表達式的求值中釋放。

(C++26 起)

成員型別

型別	定義
key_type	Key
mapped_type	T
value_type	std::pair<const Key, T>
size_type	無符號整數型別（通常是 std::size_t）
difference_type	有符號整數型別（通常是 std::ptrdiff_t）
key_compare	Compare
allocator_type	Allocator
reference	value_type&
const_reference	const value_type&
pointer	Allocator::pointer (C++11 前) std::allocator_traits<Allocator>::pointer (C++11 起)
const_pointer	Allocator::const_pointer (C++11 前) std::allocator_traits<Allocator>::const_pointer (C++11 起)
iterator	LegacyBidirectionalIterator 和 ConstexprIterator(C++26起) 到 value_type
const_iterator	LegacyBidirectionalIterator 和 ConstexprIterator(C++26起) 到 const value_type
reverse_iterator	std::reverse_iterator<iterator>
const_reverse_iterator	std::reverse_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 例項化。

成員類

value_compare

比較 value_type 型別的物件 (類)

成員函式

(建構函式)	構造 map (公共成員函式)
(解構函式)	銷燬 map (公共成員函式)
operator=	將值賦給容器 (公共成員函式)
get_allocator	返回關聯的分配器 (公共成員函式)
元素訪問
at	訪問指定的元素，帶邊界檢查 (公共成員函式)
operator[]	訪問或插入指定元素 (公共成員函式)
迭代器
begincbegin (C++11起)	返回指向起始的迭代器 (公共成員函式)
endcend (C++11起)	返回指向末尾的迭代器 (公共成員函式)
rbegincrbegin (C++11起)	返回指向起始的逆向迭代器 (公共成員函式)
rendcrend (C++11起)	返回指向末尾的逆向迭代器 (公共成員函式)
容量
empty	檢查容器是否為空 (公共成員函式)
size	返回元素數量 (公共成員函式)
max_size	返回元素的最大可能數量 (公共成員函式)
修改器
clear	清除內容 (公共成員函式)
insert	插入元素 或節點(C++17 起) (公共成員函式)
insert_range (C++23)	插入元素範圍 (公共成員函式)
insert_or_assign (C++17)	插入元素或如果鍵已存在則賦值給當前元素 (公共成員函式)
emplace (C++11)	就地構造元素 (公共成員函式)
emplace_hint (C++11)	使用提示就地構造元素 (公共成員函式)
try_emplace (C++17)	如果鍵不存在則原地插入，如果鍵存在則不執行任何操作 (公共成員函式)
erase	擦除元素 (公共成員函式)
swap	交換內容 (公共成員函式)
extract (C++17)	從容器中提取節點 (公共成員函式)
merge (C++17)	從另一個容器拼接節點 (公共成員函式)
查詢
count	返回匹配特定鍵的元素數量 (公共成員函式)
find	查詢具有特定鍵的元素 (公共成員函式)
contains (C++20)	檢查容器是否包含具有特定鍵的元素 (公共成員函式)
equal_range	返回與特定鍵匹配的元素範圍 (公共成員函式)
lower_bound	返回指向第一個不小於給定鍵的元素的迭代器 (公共成員函式)
upper_bound	返回指向第一個大於給定鍵的元素的迭代器 (公共成員函式)
觀察器
key_comp	返回比較鍵的函式 (公共成員函式)
value_comp	返回比較 value_type 型別物件中的鍵的函式 (公共成員函式)

非成員函式

operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20中移除)(C++20中移除)(C++20中移除)(C++20中移除)(C++20中移除)(C++20起)	按字典順序比較兩個 map 的值 (函式模板)
std::swap(std::map)	特化 std::swap 演算法 (函式模板)
erase_if(std::map) (C++20)	擦除所有滿足特定標準的元素 (函式模板)

推導指引

(C++17 起)

註解

特性測試宏	值	標準	特性
__cpp_lib_containers_ranges	202202L	(C++23)	容器的範圍構造和插入
__cpp_lib_constexpr_containers	202502L	(C++26)	constexpr std::map

示例

執行此程式碼

#include <iostream>
#include <map>
#include <string>
#include <string_view>
 
void print_map(std::string_view comment, const std::map<std::string, int>& m)
{
    std::cout << comment;
    // Iterate using C++17 facilities
    for (const auto& [key, value] : m)
        std::cout << '[' << key << "] = " << value << "; ";
 
// C++11 alternative:
//  for (const auto& n : m)
//      std::cout << n.first << " = " << n.second << "; ";
//
// C++98 alternative:
//  for (std::map<std::string, int>::const_iterator it = m.begin(); it != m.end(); ++it)
//      std::cout << it->first << " = " << it->second << "; ";
 
    std::cout << '\n';
}
 
int main()
{
    // Create a map of three (string, int) pairs
    std::map<std::string, int> m{{"CPU", 10}, {"GPU", 15}, {"RAM", 20}};
 
    print_map("1) Initial map: ", m);
 
    m["CPU"] = 25; // update an existing value
    m["SSD"] = 30; // insert a new value
    print_map("2) Updated map: ", m);
 
    // Using operator[] with non-existent key always performs an insert
    std::cout << "3) m[UPS] = " << m["UPS"] << '\n';
    print_map("4) Updated map: ", m);
 
    m.erase("GPU");
    print_map("5) After erase: ", m);
 
    std::erase_if(m, [](const auto& pair){ return pair.second > 25; });
    print_map("6) After erase: ", m);
    std::cout << "7) m.size() = " << m.size() << '\n';
 
    m.clear();
    std::cout << std::boolalpha << "8) Map is empty: " << m.empty() << '\n';
}

輸出

1) Initial map: [CPU] = 10; [GPU] = 15; [RAM] = 20;
2) Updated map: [CPU] = 25; [GPU] = 15; [RAM] = 20; [SSD] = 30;
3) m[UPS] = 0
4) Updated map: [CPU] = 25; [GPU] = 15; [RAM] = 20; [SSD] = 30; [UPS] = 0;
5) After erase: [CPU] = 25; [RAM] = 20; [SSD] = 30; [UPS] = 0;
6) After erase: [CPU] = 25; [RAM] = 20; [UPS] = 0;
7) m.size() = 3
8) Map is empty: true

缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 230	C++98	不要求 Key 為 可複製構造的 (CopyConstructible) （型別為 Key 的鍵可能無法構造）	Key 也要求 為可複製構造 (CopyConstructible)
LWG 464	C++98	透過鍵訪問 const map 不方便	提供了 at 函式

參閱

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