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

 

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)

 

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)。此重载仅在限定 ID Compare::is_transparent 有效并表示一种类型，且 iterator 和 const_iterator 都不能隐式地从 K 转换时，才参与重载决议。它允许在不构造 Key 实例的情况下调用此函数。

无论哪种情况，都不会复制或移动元素，只重新指向容器节点的内部指针（可能会发生重新平衡，如同 erase()）。

提取节点只会使指向被提取元素的迭代器失效。指向被提取元素的指针和引用仍然有效，但在元素被节点句柄拥有时不能使用：如果元素被插入到容器中，它们将变得可用。

参数

position	-	指向此容器的有效迭代器
k	-	用于标识要提取节点的键
x	-	可与要提取节点的键进行透明比较的任意类型的值

返回值

一个拥有被提取元素的节点句柄，如果在 (2,3) 中未找到元素，则为空节点句柄。

异常

1) 不抛出任何异常。

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

复杂度

1) 均摊常数。

2,3) log(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::map<int, char> cont{{1, 'a'}, {2, 'b'}, {3, 'c'}};
 
    print("Start:", cont);
 
    // Extract node handle and change key
    auto nh = cont.extract(1);
    nh.key() = 4;
 
    print("After extract and before insert:", cont);
 
    // Insert node handle back
    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	擦除元素 (公共成员函数)