std::multimap<Key,T,Compare,Allocator>::extract

 

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::multimap

成员函数
multimap::multimap multimap::~multimap	multimap::operator= multimap::get_allocator
迭代器
multimap::beginmultimap::cbegin (C++11) multimap::endmultimap::cend (C++11)	multimap::rbeginmultimap::crbegin (C++11) multimap::rendmultimap::crend (C++11)
容量
multimap::size multimap::max_size	multimap::empty
修改器
multimap::clear multimap::insert multimap::erase multimap::swap multimap::merge (C++17)	multimap::insert_range (C++23) multimap::emplace (C++11) multimap::emplace_hint (C++11) multimap::extract (C++17)
查找
multimap::count multimap::find multimap::contains (C++20)	multimap::equal_range multimap::lower_bound multimap::upper_bound
观察器
multimap::key_comp	multimap::value_comp
非成员函数
operator==operator!=operator<operator>operator<=operator>=operator<=> (C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20)	std::swap(std::multimap) erase_if(std::multimap) (C++20)
推导指引(C++17)

 

node_type extract( const_iterator position );	(1)	(C++17 起)
node_type extract( const Key& k );	(2)	(C++17 起)
template< class K > node_type extract( K&& x );	(3)	(C++23 起)

1) 解除含 position 所指向元素的结点的链接并返回拥有它的结点句柄。

2) 若容器拥有键等于 k 的元素，则从容器解除首个这种元素的节点并返回拥有它的结点句柄。否则，返回空结点句柄。

3) 同 (2)。此重载只有在限定标识 Compare::is_transparent 合法并指代类型，且 iterator 与 const_iterator 均不可从 K 隐式转换时才会参与重载决议。它允许调用此函数时无需构造 Key 的实例。

任何情况下，均不复制或移动元素，只重指向容器结点的内部指针（可能发生再平衡，和 erase() 一样）。

提取结点只会使指向被提取元素的迭代器失效。指向被提取元素的指针和引用保持有效，但在结点句柄拥有该元素时不能使用：一旦元素被插入容器，就能使用它们。

参数

position	-	指向此容器中的合法迭代器
k	-	鉴别要提取的结点的键
x	-	任何能与键通透比较的类型的值，鉴别要提取的结点

返回值

拥有被提取元素的结点句柄，或 (2,3) 中找不到元素的情况下为空结点句柄。

异常

1) 不抛出。

2,3) 由 Compare 对象所抛出的任何异常。

复杂度

1) 均摊常数

2,3) log(a.size())

注解

extract 是更换 map 的键而不重分配的唯一方式：

std::map<int, std::string> m{{1, "mango"}, {2, "papaya"}, {3, "guava"}};
auto nh = m.extract(2);
nh.key() = 4;
m.insert(std::move(nh));
// m == {{1, "mango"}, {3, "guava"}, {4, "papaya"}}

功能特性测试宏	值	标准	功能特性
__cpp_lib_associative_heterogeneous_erasure	202110L	(C++23)	关联容器和无序关联容器中的异质擦除, (3)

示例

运行此代码

#include <algorithm>
#include <iostream>
#include <string_view>
#include <map>
 
void print(std::string_view comment, const auto& data)
{
    std::cout << comment;
    for (auto [k, v] : data)
        std::cout << ' ' << k << '(' << v << ')';
 
    std::cout << '\n';
}
 
int main()
{
    std::multimap<int, char> cont{{1, 'a'}, {2, 'b'}, {3, 'c'}};
 
    print("Start:", cont);
 
    // 提取节点句柄并改变键
    auto nh = cont.extract(1);
    nh.key() = 4;
 
    print("After extract and before insert:", cont);
 
    // 将节点句柄插回去
    cont.insert(std::move(nh));
 
    print("End:", cont);
}

输出：

Start: 1(a) 2(b) 3(c)
After extract and before insert: 2(b) 3(c)
End: 2(b) 3(c) 4(a)

参阅

merge (C++17)	从另一容器合并节点 (公开成员函数)
insert	插入元素或节点 (C++17 起) (公开成员函数)
erase	擦除元素 (公开成员函数)