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

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

容器库

node-handle (C++17)

序列容器

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_multimap

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

 

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

1) 解除含 pos 所指向元素的节点的链接并返回拥有它的节点把柄。

2,3) 如果容器拥有键等价于 k 或 x (C++23 起)的元素，那么就会从容器解除首个这种元素的节点的链接并返回拥有它的节点把柄。否则返回空节点把柄。

3) 此重载只有在 Hash 和 KeyEqual 均透明，且 iterator 与 const_iterator 均不可从 K 隐式转换时才会参与重载决议。这假设使得 Hash 能用 K 和 Key 类型调用，并且 KeyEqual 是透明的，进而允许调用此函数时不需要构造 Key 的实例。

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

提取节点只会使指向被提取元素的迭代器失效，并保持未被擦除元素的相对顺序。指向被提取元素的指针和引用保持有效，但在节点把柄拥有该元素时不能使用：一旦元素被插入容器，就能使用它们。

参数

pos	-	指向此容器中的有效迭代器
k	-	鉴别要提取的节点的键
x	-	任何能与键透明比较的类型的值，鉴别要提取的节点

返回值

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

异常

1) 不抛出。

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

复杂度

1-3) 平均情况 O(1)，最坏情况 O(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 <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_multimap<int, char> cont{{1, 'a'}, {2, 'b'}, {3, 'c'}};
 
    print("开始：", cont);
 
    // 提取节点把柄并改变键
    auto nh = cont.extract(1);
    nh.key() = 4;
 
    print("extract 和 insert 之间：", cont);
 
    // 将节点把柄插回去
    cont.insert(std::move(nh));
 
    print("结束：", cont);
}

可能的输出：

开始：1(a) 2(b) 3(c)
extract 和 insert 之间：2(b) 3(c)
结束：2(b) 3(c) 4(a)

参阅

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