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

 

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)

 

template< class... Args > std::pair<iterator, bool> try_emplace( const Key& k, Args&&... args );	(1)	(C++17以降)
template< class... Args > std::pair<iterator, bool> try_emplace( Key&& k, Args&&... args );	(2)	(C++17以降)
template< class K, class... Args > std::pair<iterator, bool> try_emplace( K&& k, Args&&... args );	(3)	(C++26以降)
template< class... Args > iterator try_emplace( const_iterator hint, const Key& k, Args&&... args );	(4)	(C++17以降)
template< class... Args > iterator try_emplace( const_iterator hint, Key&& k, Args&&... args );	(5)	(C++17以降)
template< class K, class... Args > iterator try_emplace( const_iterator hint, K&& k, Args&&... args );	(6)	(C++26以降)

コンテナ内に k と等価なキーがすでに存在する場合、何も行わない。そうでない場合、キー k と args で構築された値を持つ新しい要素をコンテナに挿入する。この場合、

1) emplace と同様に動作するが、要素は以下のように構築される。
value_type(std::piecewise_construct,

           std::forward_as_tuple(k),

           std::forward_as_tuple(std::forward<Args>(args)...))

2) emplace と同様に動作するが、要素は以下のように構築される。
value_type(std::piecewise_construct,

           std::forward_as_tuple(std::move(k)),

           std::forward_as_tuple(std::forward<Args>(args)...))

3) emplace と同様に動作するが、要素は以下のように構築される。
value_type(std::piecewise_construct,

           std::forward_as_tuple(std::forward<K>(k)),

           std::forward_as_tuple(std::forward<Args>(args)...))

4) emplace_hint と同様に動作するが、要素は以下のように構築される。
value_type(std::piecewise_construct,

           std::forward_as_tuple(k),

           std::forward_as_tuple(std::forward<Args>(args)...))

5) emplace_hint と同様に動作するが、要素は以下のように構築される。
value_type(std::piecewise_construct,

           std::forward_as_tuple(std::move(k)),

           std::forward_as_tuple(std::forward<Args>(args)...))

6) emplace_hint と同様に動作するが、要素は以下のように構築される。
value_type(std::piecewise_construct,

           std::forward_as_tuple(std::forward<K>(k)),

           std::forward_as_tuple(std::forward<Args>(args)...))

1-6) `value_type` が対応する式から `unordered_map` にEmplaceConstructibleでない場合、動作は未定義。

3) このオーバーロードは、以下のすべての条件が満たされている場合にのみ、オーバーロード解決に参加する。

• std::is_convertible_v<K&&, const_iterator> と std::is_convertible_v<K&&, iterator> は両方とも false。
• Hash::is_transparent と KeyEqual::is_transparent は有効であり、それぞれ型を示す。

もし hash_function()(u.first) != hash_function()(k) || contains(u.first) が true の場合、動作は未定義。ここで u は挿入される新しい要素である。

6) このオーバーロードは、Hash::is_transparent と KeyEqual::is_transparent の両方が有効で、それぞれ型を示す場合にのみ、オーバーロード解決に参加する。

もし hash_function()(u.first) != hash_function()(k) || contains(u.first) が true の場合、動作は未定義。ここで u は挿入される新しい要素である。

操作後、要素の新しい数が古い max_load_factor() * bucket_count() より大きい場合、リハッシュが行われる。
リハッシュが発生した場合（挿入による）、すべてのイテレータは無効化される。それ以外の場合（リハッシュなし）、イテレータは無効化されない。

パラメータ

k	-	検索および見つからなかった場合に挿入するために使用されるキー
hint	-	新しい要素が挿入される前の位置へのイテレータ
args	-	要素のコンストラクタに転送する引数

戻り値

1-3) emplace と同じ
挿入された要素へのイテレータ（または挿入を妨げた要素へのイテレータ）と、挿入が行われた場合にのみ true に設定される bool 値からなるペア。

4-6) emplace_hint と同じ
挿入された要素へのイテレータ、または挿入を妨げた要素へのイテレータ。

計算量

1-3) emplace と同じ
平均的には償却定数時間、最悪の場合コンテナのサイズに比例する線形時間。

4-6) emplace_hint と同じ
平均的には償却定数時間、最悪の場合コンテナのサイズに比例する線形時間。

備考

insert や emplace とは異なり、これらの関数は挿入が行われない場合に右辺値引数からムーブしないため、std::unordered_map<std::string, std::unique_ptr<foo>> のようなムーブオンリーな型の値を扱うマップの操作が容易になる。さらに、`try_emplace` はキーと `mapped_type` への引数を個別に扱うが、emplace は `value_type` (すなわち std::pair) を構築するための引数を必要とする。

オーバーロード (3,6) は、型 `Key` のオブジェクトを構築することなく呼び出すことができる。

機能テストマクロ	値	規格	機能
__cpp_lib_unordered_map_try_emplace	201411L	(C++17)	std::unordered_map::try_emplace, std::unordered_map::insert_or_assign
__cpp_lib_associative_heterogeneous_insertion	202311L	(C++26)	順序付きおよび非順序連想コンテナの残りのメンバ関数の異種オーバーロード。オーバーロード (3) および (6)。

例

このコードを実行

#include <iostream>
#include <string>
#include <unordered_map>
#include <utility>
 
void print_node(const auto& node)
{
    std::cout << '[' << node.first << "] = " << node.second << '\n';
}
 
void print_result(auto const& pair)
{
    std::cout << (pair.second ? "inserted: " : "ignored:  ");
    print_node(*pair.first);
}
 
int main()
{
    using namespace std::literals;
    std::unordered_map<std::string, std::string> m;
 
    print_result(m.try_emplace("a", "a"s));
    print_result(m.try_emplace("b", "abcd"));
    print_result(m.try_emplace("c", 10, 'c'));
    print_result(m.try_emplace("c", "Won't be inserted"));
 
    for (const auto& p : m)
        print_node(p);
}

実行結果の例

inserted: [a] = a
inserted: [b] = abcd
inserted: [c] = cccccccccc
ignored:  [c] = cccccccccc
[a] = a
[b] = abcd
[c] = cccccccccc

関連項目

emplace	要素を直接構築する (公開メンバ関数)
emplace_hint	ヒントを使用して要素を直接構築する (公開メンバ関数)
insert	要素 またはノード(C++17以降)を挿入する (公開メンバ関数)