std::map

来自cppreference.com
< cpp‎ | container
 
C++
 
容器库
 
std::map
 
在标头 <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 通常实现为红黑树。

标准库使用比较 (Compare) 概念时用等价关系确定唯一性。不精确地说，如果两个对象 a 与 b 相互不比较小于对方：!comp(a, b) && !comp(b, a)，那么认为它们等价。

std::map 满足容器 (Container) 、知分配器容器 (AllocatorAwareContainer) 、关联容器 (AssociativeContainer) 和可逆容器 (ReversibleContainer) 的要求。

成员类型

成员类型 定义
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 指向 value_type 的老式双向迭代器 (LegacyBidirectionalIterator)
const_iterator 指向 const value_type 的老式双向迭代器 (LegacyBidirectionalIterator)
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_type的对象
(类)

成员函数

 构造 map
(公开成员函数)
析构 map
(公开成员函数)
赋值给容器
(公开成员函数)
返回相关的分配器
(公开成员函数)
元素访问
访问指定的元素，同时进行越界检查
(公开成员函数)
访问或插入指定的元素
(公开成员函数)
迭代器
(C++11)
 返回指向起始的迭代器
(公开成员函数)
(C++11)
 返回指向末尾的迭代器
(公开成员函数)
(C++11)
 返回指向起始的逆向迭代器
(公开成员函数)
(C++11)
 返回指向末尾的逆向迭代器
(公开成员函数)
容量
检查容器是否为空
(公开成员函数)
返回容纳的元素数
(公开成员函数)
返回可容纳的最大元素数
(公开成员函数)
修改器
清除内容
(公开成员函数)
插入元素或结点 (C++17 起)
(公开成员函数)
(C++17)
 插入元素，或若键已存在则赋值给当前元素
(公开成员函数)
(C++11)
 原位构造元素
(公开成员函数)
(C++11)
 使用提示原位构造元素
(公开成员函数)
(C++17)
 若键不存在则原位插入，若键存在则不做任何事
(公开成员函数)
擦除元素
(公开成员函数)
交换内容
(公开成员函数)
(C++17)
 从另一容器提取节点
(公开成员函数)
(C++17)
 从另一容器合并节点
(公开成员函数)
查找
返回匹配特定键的元素数量
(公开成员函数)
寻找带有特定键的元素
(公开成员函数)
(C++20)
 检查容器是否含有带特定键的元素
(公开成员函数)
返回匹配特定键的元素范围
(公开成员函数)
返回指向首个不小于给定键的元素的迭代器
(公开成员函数)
返回指向首个大于给定键的元素的迭代器
(公开成员函数)
观察器
返回用于比较键的函数
(公开成员函数)
返回用于在value_type类型的对象中比较键的函数。
(公开成员函数)

非成员函数

(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20)
 按照字典顺序比较 map 中的值
(函数模板)
特化 std::swap 算法
(函数模板)
(C++20)
 擦除所有满足特定判别标准的元素
(函数模板)

推导指引(C++17 起)

示例

运行此代码
#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;
    // 使用 C++17 设施进行遍历
    for (const auto& [key, value] : m)
        std::cout << '[' << key << "] = " << value << "; ";
 
// C++11 方案：
//  for (const auto& n : m)
//      std::cout << n.first << " = " << n.second << "; ";
//
// C++98 方案：
//  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()
{
    // 创建包含三对 (string, int) 的 map
    std::map<std::string, int> m{{"CPU", 10}, {"GPU", 15}, {"RAM", 20}};
 
    print_map("1) 初始 map：", m);
 
    m["CPU"] = 25; // 更新已经存在的值
    m["SSD"] = 30; // 插入新值
    print_map("2) 更新后的 map：", m);
 
    // 以不存在的键使用 operator[] 总是会执行插入操作
    std::cout << "3) m[UPS] = " << m["UPS"] << '\n';
    print_map("4) 更新后的 map：", m);
 
    m.erase("GPU");
    print_map("5) 移除后：", m);
 
    std::erase_if(m, [](const auto& pair){ return pair.second > 25; });
    print_map("6) 移除后：", m);
    std::cout << "7) m.size() = " << m.size() << '\n';
 
    m.clear();
    std::cout << std::boolalpha << "8) map 为空：" << m.empty() << '\n';
}

输出： 

1) 初始 map：[CPU] = 10; [GPU] = 15; [RAM] = 20; 
2) 更新后的 map[CPU] = 25; [GPU] = 15; [RAM] = 20; [SSD] = 30; 
3) m[UPS] = 0
4) 更新后的 map[CPU] = 25; [GPU] = 15; [RAM] = 20; [SSD] = 30; [UPS] = 0; 
5) 移除后：[CPU] = 25; [RAM] = 20; [SSD] = 30; [UPS] = 0; 
6) 移除后：[CPU] = 25; [RAM] = 20; [UPS] = 0; 
7) m.size() = 3
8) map 为空：true

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 230 C++98 Key 不需要满足可复制构造 (CopyConstructible)
（因此不保证能构造 Key 类型的键） 		Key 也需要满足
可复制构造 (CopyConstructible)
LWG 464 C++98 以键访问 const map 不方便 提供 at 函数
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/container/map&oldid=75494”