最終更新日時(UTC):
が更新

履歴 編集

function
<unordered_map>

std::unordered_map::insert(C++11)

pair<iterator, bool> insert(const value_type& v);              // (1)

template <class P>
pair<iterator, bool> insert(P&& obj);                          // (2)

iterator insert(const_iterator position, const value_type& v); // (3)

template <class P>
iterator insert(const_iterator position, P&& obj);             // (4)

template <class InputIterator>
void insert(InputIterator first, InputIterator last);          // (5)

void insert(initializer_list<value_type> il);                  // (6)

概要

コンテナに要素を追加する。

要件

  • v を引数にとる形式((1)、(3))では、value_type はコンテナに対してコピー挿入可能(CopyInsertable)でなければならない。
    コンテナに対してコピー挿入可能とは、m をアロケータ型 allocator_type の左辺値、p を要素型 value_type へのポインタとすると、以下の式が適格(well-formed)であるということである。

    std::allocator_traits<allocator_type>::construct(m, p, v);

  • obj を引数にとる形式((2)、(4))では、value_type は引数 obj からコンテナに対して直接構築可能(EmplaceConstructible)でなければならない。
    コンテナに対して直接構築可能とは、m をアロケータ型 allocator_type の左辺値、p を要素型 value_type へのポインタとすると、以下の式が適格(well-formed)であるということである。

    std::allocator_traits<allocator_type>::construct(m, p, std::forward<P>(obj));

  • 引数 position は、コンテナの有効な読み取り専用イテレータでなければならない。
    なお、規格書では間接参照可能(dereferenceable)である必要があることになっているが、その必要はない(つまり、最終要素の次を指すイテレータでも良い)ものと思われる。

  • 引数 first、および、lastは、入力イテレータの要件を満たし、かつ、範囲 [first, last) が当該コンテナ以外を指す有効な範囲でなければならない。
    また、引数 first、および、last を引数にとる形式((5))では、このコンテナの要素型 value_type は、コンテナに対して *first から直接構築可能(EmplaceConstructible)でなければならない。
    ここで、コンテナに対して *first から直接構築可能とは、m をアロケータ型 allocator_type の左辺値、p を要素型 value_type へのポインタとすると、以下の式が適格(well-formed)であるということである。

    std::allocator_traits<allocator_type>::construct(m, p, *first);

    なお、first、および、lastは、規格書では value_type を参照しなければならない(つまり、コンテナの value_typestd::iterator_traits<decltype(first)>::value_type が同一の型でなければならない)ことになっているが、実際にはその必要はなく、上記の直接構築可能の要件を満たすだけで良いものと思われる。

  • (6)の形式では、value_type はコンテナに対してコピー挿入可能でなければならない。

効果

  • (1) : v.first と等価なキーがコンテナに存在していなければ、当該要素を追加する。
  • (2) : 引数 obj から構築されたオブジェクトを v とすると、v.first と等価なキーがコンテナに存在していなければ、当該要素を追加する。
    • このバージョンの動作は、emplace(std::forward<P>(obj))を呼び出した場合と同等である。
  • (3) : v.first と等価なキーがコンテナに存在していなければ、当該要素を追加する。
    引数 position は、要素の挿入位置を探し始める場所のヒントとして使用されるが、実装によって無視されるかもしれない。
  • (4) : 引数 obj から構築されたオブジェクトを v とすると、v.first と等価なキーがコンテナに存在していなければ、当該要素を追加する。
    引数 position は、要素の挿入位置を探し始める場所のヒントとして使用されるが、実装によって無視されるかもしれない。
    • このバージョンの動作は、emplace_hint(hint, std::forward<P>(obj))を呼び出した場合と同等である。
  • (5) : 範囲 [first, last) のすべての要素 t に対して、insert(t) を呼び出した場合と同等である(*first の型によって (1)、あるいは(2)の形式が呼び出される)。
  • (6) : (5)の形式を insert(il.begin(), il.end()) として呼び出した場合と同等である。

戻り値

  • (1)、(2) : pairbool 部分(second 部)は、要素が追加されたら true、追加されなかったら(既にあったら)false
    pairiterator 部分(first 部)は、追加された要素(bool 部分が true の場合)、あるいは、既にあった要素(bool 部分が false の場合)を指すイテレータ。
  • (3)、(4) : 新たな要素が追加された場合、その追加された要素を指すイテレータ。
    新たな要素が追加されなかった場合、既にあった要素を指すイテレータ。
  • (5)、(6) : なし

例外

単一要素の形式((1)から(4))では、ハッシュ関数以外から例外が投げられた場合には、挿入はされない。

計算量

  • (1)から(4) : 平均的なケースでは定数(O(1))だが、最悪のケースではコンテナの要素数 size() に比例(O(N))。
  • (5) : 平均的なケースでは引数の範囲の要素数 std::distance(first, last) に比例(O(N))するが、最悪のケースでは引数の範囲の要素数 std::distance(first, last) とコンテナの要素数 size() に 1 加えたものの積に比例(O(std::distance(first, last) * (size() + 1)))。
  • (6) : (5)の形式を insert(il.begin(), il.end()) として呼び出した場合と同等。

備考

  • これらの関数が呼ばれた後も、当該コンテナ内の要素を指す参照は無効にはならない。 なお、規格書に明確な記載は無いが、当該コンテナ内の要素を指すポインタも無効にはならない。

  • これらの関数が呼ばれた後も、呼び出しの前後でこのコンテナのバケット数(bucket_count() の戻り値)が変わらなかった場合には当該コンテナを指すイテレータは無効にはならない。
    それ以外の場合は、当該コンテナを指すイテレータは無効になる可能性がある。
    コンテナのバケット数が変わらない場合とは、

    • 追加しようとした要素と等価なキーの要素が全て既にコンテナに存在したため、要素が追加されなかった。
    • 要素追加後の要素数が、要素追加前のバケット数(bucket_count() の戻り値)×最大負荷率(max_load_factor() の戻り値)よりも小さかった。

    のいずれかである。
    なお、後者の条件は「よりも小さい」となっているが、最大負荷率の定義からすると「以下」の方が適切と思われる。reserve も参照。

  • (2)、および、(4) の形式は、Pvalue_type に暗黙変換可能でなければオーバーロード解決の対象にはならない。
    但し、この条件は規格書が当初意図した条件よりも厳しい(※)ため、C++14 では「std::is_constructible<value_type, P&&>::valuetrue であること」に修正される予定である。
    key_type がムーブのみ可能(コピー不可能)の場合、std::pair<key_type, mapped_type> から std::pair<const key_type, mapped_type> へ暗黙変換可能ではない

#include <iostream>
#include <unordered_map>
#include <forward_list>
#include <algorithm>
#include <string>
#include <utility>
#include <initializer_list>

using cis = std::pair<const int, std::string>;
using is  = std::pair<int, std::string>;

std::ostream& operator<<(std::ostream& os, const cis& p)
{
    return os << '(' << p.first << ',' << p.second << ')';
}

template <class C>
void print(const char* label, const C& c, std::ostream& os = std::cout)
{
  os << label << " : ";
  std::for_each(c.cbegin(), c.cend(), [&os](const cis& p) { os << p << ", "; });
  os << '\n';
}

int main()
{
  std::cout << std::boolalpha;

  // 一つの要素を挿入((1)の形式)
  {
    std::unordered_map<int, std::string> um{ {0, "zero"}, {1, "one"}, {2, "two"}, {3, "three"}, {4, "four"}, {5, "five"}, };

    auto p1 = um.insert(cis{6, "6th"}); // 追加されるケース
    std::cout << p1.second << ' ' << *p1.first << ' ';
    auto p2 = um.insert(cis{2, "2nd"}); // 追加されないケース
    std::cout << p2.second << ' ' << *p2.first << std::endl;
    print("insert one element", um);
  }

  // 一つの要素を挿入((2)の形式)
  {
    std::unordered_map<int, std::string> um{ {0, "zero"}, {1, "one"}, {2, "two"}, {3, "three"}, {4, "four"}, {5, "five"}, };

    auto p1 = um.insert(is{6, "6th"}); // 追加されるケース
    std::cout << p1.second << ' ' << *p1.first << ' ';
    auto p2 = um.insert(is{2, "2nd"}); // 追加されないケース
    std::cout << p2.second << ' ' << *p2.first << std::endl;
    print("insert one element", um);
  }

  // 一つの要素を挿入((3)の形式)
  {
    std::unordered_map<int, std::string> um{ {0, "zero"}, {1, "one"}, {2, "two"}, {3, "three"}, {4, "four"}, {5, "five"}, };

    auto it1 = um.insert(um.cbegin(), cis{6, "6th"}); // 追加されるケース
    std::cout << *it1 << ' ';
    auto it2 = um.insert(um.cbegin(), cis{2, "2nd"}); // 追加されないケース
    std::cout << *it2 << std::endl;
    print("insert one element with hint", um);
  }

  // 一つの要素を挿入((4)の形式)
  {
    std::unordered_map<int, std::string> um{ {0, "zero"}, {1, "one"}, {2, "two"}, {3, "three"}, {4, "four"}, {5, "five"}, };

    auto it1 = um.insert(um.cbegin(), is{6, "6th"}); // 追加されるケース
    std::cout << *it1 << ' ';
    auto it2 = um.insert(um.cbegin(), is{2, "2nd"}); // 追加されないケース
    std::cout << *it2 << std::endl;
    print("insert one element with hint", um);
  }

  // 複数の要素を挿入((5)の形式)
  {
    std::unordered_map<int, std::string> um{ {0, "zero"}, {1, "one"}, {2, "two"}, {3, "three"}, {4, "four"}, {5, "five"}, };

    std::forward_list<std::pair<short, const char*>> fl{ {5, "5th"}, {6, "6th"}, {0, "0th"}, {8, "8th"}, {7, "7th"}, };
    um.insert(fl.cbegin(), fl.cend()); // forward_list の要素を全部
    print("insert range", um);
  }

  // 複数の要素を挿入((6)の形式)
  {
    std::unordered_map<int, std::string> um{ {0, "zero"}, {1, "one"}, {2, "two"}, {3, "three"}, {4, "four"}, {5, "five"}, };

    um.insert({ {5, "5th"}, {6, "6th"}, {0, "0th"}, {8, "8th"}, {7, "7th"}, });
    print("insert initializer_list", um);
  }
}

出力

true (6,6th) false (2,two)
insert one element : (6,6th), (5,five), (4,four), (3,three), (2,two), (1,one), (0,zero), 
true (6,6th) false (2,two)
insert one element : (6,6th), (5,five), (4,four), (3,three), (2,two), (1,one), (0,zero), 
(6,6th) (2,two)
insert one element with hint : (6,6th), (5,five), (4,four), (3,three), (2,two), (1,one), (0,zero), 
(6,6th) (2,two)
insert one element with hint : (6,6th), (5,five), (4,four), (3,three), (2,two), (1,one), (0,zero), 
insert range : (7,7th), (8,8th), (6,6th), (5,five), (4,four), (3,three), (2,two), (1,one), (0,zero), 
insert initializer_list : (7,7th), (8,8th), (6,6th), (5,five), (4,four), (3,three), (2,two), (1,one), (0,zero), 

注:unordered_map は非順序連想コンテナであるため、出力順序は無意味であることに注意

バージョン

言語

  • C++11

処理系

実装例

(3)以降の形式は、(1)、および、(2)の形式を使って実装することができる。

template <class Key, class Hash, class Pred, class Allocator>
inline iterator unordered_map<Key, Hash, Pred, Allocator>::insert(const_iterator, const value_type& v)
{
  return insert(v).first;
}

template <class Key, class Hash, class Pred, class Allocator>
template <class P>
inline iterator unordered_map<Key, Hash, Pred, Allocator>::insert(const_iterator, P&& obj)
{
  return insert(std::forward<P>(obj)).first;
}

template <class Key, class Hash, class Pred, class Allocator>
template <class InputIterator>
inline void unordered_map<Key, Hash, Pred, Allocator>::insert(InputIterator first, InputIterator last);
{
  for (; first != last; ++first)
    insert(*first);
}

template <class Key, class Hash, class Pred, class Allocator>
inline void unordered_map<Key, Hash, Pred, Allocator>::insert(initializer_list<Key> il);
{
  insert(il.begin(), il.end());
}

関連項目

emplace コンテナ内への要素の直接構築
emplace_hint 挿入位置のヒントを使用したコンテナ内への要素の直接構築
erase 要素の削除
clear 全要素の削除
swap 内容の交換
bucket_count バケット数の取得
load_factor 現在の負荷率(バケットあたりの要素数の平均)を取得
max_load_factor 負荷率の最大値を取得、設定
rehash 最小バケット数指定によるバケット数の調整
reserve 最小要素数指定によるバケット数の調整

参照