std::unordered_map<Key,T,Hash,KeyEqual,Allocator>::extract

 

C++

编译器支持

独立和宿主

语言

标准库

标准库头文件

具名要求

特性测试宏 (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::unordered_map

成员类型
成员函数
unordered_map::unordered_map unordered_map::~unordered_map unordered_map::operator= unordered_map::get_allocator 迭代器 unordered_map::beginunordered_map::cbegin unordered_map::endunordered_map::cend 容量 unordered_map::size unordered_map::max_size unordered_map::empty 修改器 unordered_map::clear unordered_map::erase unordered_map::swap unordered_map::extract (C++17) unordered_map::merge (C++17) unordered_map::insert unordered_map::insert_range (C++23) unordered_map::insert_or_assign (C++17)   unordered_map::emplace unordered_map::emplace_hint unordered_map::try_emplace (C++17)	查找 unordered_map::at unordered_map::operator[] unordered_map::count unordered_map::find unordered_map::contains (C++20) unordered_map::equal_range 桶接口 unordered_map::begin(size_type)unordered_map::cbegin(size_type) unordered_map::end(size_type)unordered_map::cend(size_type) unordered_map::bucket_count unordered_map::max_bucket_count unordered_map::bucket_size unordered_map::bucket 哈希策略 unordered_map::load_factor unordered_map::max_load_factor unordered_map::rehash unordered_map::reserve 观察器 unordered_map::hash_function unordered_map::key_eq
非成员函数
operator==operator!= (until C++20)	std::swap(std::unordered_map) erase_if(std::unordered_map) (C++20)
推导指引(C++17)

 

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

1) 解链含有由 position 所指向的元素的节点，并返回拥有它的节点句柄。

2) 如果容器拥有与 k 等价键的元素，则解链含有该元素的节点，并从容器返回拥有它的节点句柄。否则，返回空节点句柄。

3) 与 (2) 相同。此重载仅在 Hash::is_transparent 和 KeyEqual::is_transparent 为有效且各自表示类型，且 iterator 与 const_iterator 均非隐式可从 K 转换而来时参与重载决议。这假定此类 Hash 可用 K 和 Key 类型调用，且 KeyEqual 是透明的，它们一起允许在不构造 Key 实例的情况下调用此函数。

在任何情况下，都不会复制或移动元素，仅重指向容器节点的内部指针。

提取节点仅会使指向被提取元素的迭代器失效，并保持未擦除元素的相对顺序。指向被提取元素的指针和引用保持有效，但在元素为节点句柄所拥有时不可用：若元素被插入到容器中，则它们变为可用。

参数

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

返回值

节点句柄，它拥有被提取的元素；或者在 (2,3) 中未找到元素的情况下为空节点句柄。

异常

1) 不抛出异常。

2,3) 由 Hash 和 KeyEqual 对象抛出的任何异常。

复杂度

1,2,3) 平均情况 O(1)，最坏情况 O(size())。

注意

extract 是更改映射元素的键而不重新分配的唯一方法

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"}}

特性测试 宏	值	Std	特性
__cpp_lib_associative_heterogeneous_erasure	202110L	(C++23)	在关联容器和无序关联容器中的异质擦除，(3)

示例

运行此代码

#include <algorithm>
#include <iostream>
#include <string_view>
#include <unordered_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::unordered_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)	从另一容器拼接节点 (public member function)
insert	插入元素或节点(since C++17) (public member function)
erase	擦除元素 (public member function)