std::unordered_set<Key,Hash,KeyEqual,Allocator>::extract

来自cppreference.com
See More

[编辑模板]
 
C++
 
容器库
 
std::unordered_set
成员类型
成员函数
非成员函数
推导指引 (C++17)
 
<tbody> </tbody>
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)。此重载只有在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(a.size())。

注解

extract 是从 set 带走仅移动对象的唯一方式： 

std::set<move_only_type> s;
s.emplace(...);
move_only_type mot = std::move(s.extract(s.begin()).value());
功能特性测试宏 值 标准 功能特性
__cpp_lib_associative_heterogeneous_erasure 202110L (C++23) 关联容器和无序关联容器中的异质擦除, (3)

示例

运行此代码
#include <algorithm>
#include <iostream>
#include <string_view>
#include <unordered_set>

void print(std::string_view comment, const auto& data)
{
    std::cout << comment;
    for (auto datum : data)
        std::cout << ' ' << datum;

    std::cout << '\n';
}
 
int main()
{
    std::unordered_set<int> cont{1, 2, 3};

    print("Start:", cont);
    
    // 提取节点句柄并改变键
    auto nh = cont.extract(1);
    nh.value() = 4;

    print("After extract and before insert:", cont);
 
    // 将节点句柄插回去
    cont.insert(std::move(nh));

    print("End:", cont);
}

可能的输出： 

Start: 1 2 3
After extract and before insert: 2 3
End: 2 3 4

参阅

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