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

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

コンテナライブラリ

シーケンス

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!= (C++20まで)	std::swap(std::unordered_map) erase_if(std::unordered_map) (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) と同じです。このオーバーロードは、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 は、再割り当てなしで 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_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	要素を削除する (公開メンバ関数)