std::multimap<Key,T,Compare,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::multimap

メンバ関数

multimap::multimap multimap::~multimap        multimap::operator= multimap::get_allocator

イテレータ multimap::beginmultimap::cbegin (C++11) multimap::endmultimap::cend (C++11) multimap::rbeginmultimap::crbegin (C++11)    multimap::rendmultimap::crend (C++11) 容量 multimap::size multimap::max_size multimap::empty 監視 multimap::key_comp multimap::value_comp 変更 multimap::clear multimap::insert multimap::erase multimap::swap multimap::merge (C++17) multimap::insert_range (C++23) multimap::emplace (C++11) multimap::emplace_hint (C++11) multimap::extract (C++17) 検索 multimap::count multimap::find multimap::contains (C++20) multimap::equal_range multimap::lower_bound multimap::upper_bound

非メンバ関数

operator==operator<=> (C++20) std::swap(std::multimap) erase_if(std::multimap) (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::multimap<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	要素を削除する (公開メンバ関数)