std::set<Key,Compare,Allocator>::emplace_hint

 

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::set

メンバ関数

set::set set::~set            set::operator= set::get_allocator

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

非メンバ関数

operator==operator<=> (C++20) std::swap(std::set) erase_if(std::set) (C++20)   operator!=operator<operator>operator<=operator>= (C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)

推論補助(C++17)

 

template< class... Args > iterator emplace_hint( const_iterator hint, Args&&... args );		(C++11以降)

hint の直前の位置に、できるだけ近い位置へ新しい要素をコンテナに挿入します。

キーおよびマッピング値のコンストラクタは、関数に供給されたものと全く同じ引数で呼び出され、std::forward<Args>(args)... によって転送されます。

イテレータや参照は無効化されない。

パラメータ

hint	-	新しい要素が挿入される前の位置へのイテレータ
args	-	要素のコンストラクタに転送する引数

返り値

挿入された要素へのイテレータ、または挿入を妨げた要素へのイテレータ。

例外

何らかの理由で例外がスローされた場合、この関数は効果がありません（強力な例外安全保証）。

計算量

一般的にはコンテナのサイズに対して対数時間だが、新しい要素が hint の直前に挿入された場合は償却定数時間。

例

このコードを実行

#include <chrono>
#include <cstddef>
#include <functional>
#include <iomanip>
#include <iostream>
#include <set>
 
const int n_operations = 100'500'0;
 
std::size_t set_emplace()
{
    std::set<int> set;
    for (int i = 0; i < n_operations; ++i)
        set.emplace(i);
    return set.size();
}
 
std::size_t set_emplace_hint()
{
    std::set<int> set;
    auto it = set.begin();
    for (int i = 0; i < n_operations; ++i)
    {
        set.emplace_hint(it, i);
        it = set.end();
    }
    return set.size();
}
 
std::size_t set_emplace_hint_wrong()
{
    std::set<int> set;
    auto it = set.begin();
    for (int i = n_operations; i > 0; --i)
    {
        set.emplace_hint(it, i);
        it = set.end();
    }
    return set.size();
}
 
std::size_t set_emplace_hint_corrected()
{
    std::set<int> set;
    auto it = set.begin();
    for (int i = n_operations; i > 0; --i)
    {
        set.emplace_hint(it, i);
        it = set.begin();
    }
    return set.size();
}
 
std::size_t set_emplace_hint_closest()
{
    std::set<int> set;
    auto it = set.begin();
    for (int i = 0; i < n_operations; ++i)
        it = set.emplace_hint(it, i);
    return set.size();
}
 
double time_it(std::function<std::size_t()> set_test,
               const char* what = nullptr,
               double ratio = 0.0)
{
    const auto start = std::chrono::system_clock::now();
    const std::size_t setsize = set_test();
    const auto stop = std::chrono::system_clock::now();
    const std::chrono::duration<double, std::milli> time = stop - start;
    if (what != nullptr && setsize > 0)
        std::cout << std::setw(8) << time << " for " << what << " (ratio: "
                  << (ratio == 0.0 ? 1.0 : ratio / time.count()) << ")\n";
    return time.count();
}
 
int main()
{
    std::cout << std::fixed << std::setprecision(2);
    time_it(set_emplace); // cache warmup
    const auto x = time_it(set_emplace, "plain emplace");
    time_it(set_emplace_hint, "emplace with correct hint", x);
    time_it(set_emplace_hint_wrong, "emplace with wrong hint", x);
    time_it(set_emplace_hint_corrected, "corrected emplace", x);
    time_it(set_emplace_hint_closest, "emplace using returned iterator", x);
}

実行結果の例

392.25ms for plain emplace (ratio: 1.00)
 97.15ms for emplace with correct hint (ratio: 4.04)
387.52ms for emplace with wrong hint (ratio: 1.01)
 84.80ms for corrected emplace (ratio: 4.63)
 83.67ms for emplace using returned iterator (ratio: 4.69)

関連項目

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