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

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

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

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

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

insert_return_type insert(node_type&& nh);                     // (5) C++17
iterator insert(const_iterator hint, node_type&& nh);          // (6) C++17

概要

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

要件

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

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

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

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

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

• 引数 first、および、lastは、入力イテレータの要件を満たし、かつ、イテレータ範囲 [first, last) が当該コンテナ以外を指す有効な範囲でなければならない。
  また、引数 first、および、last を引数にとる形式（(3)）では、このコンテナの要素型 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_type と std::iterator_traits<decltype(first)>::value_type が同一の型でなければならない）ことになっているが、実際にはその必要はなく、上記の直接構築可能の要件を満たすだけで良いものと思われる。

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

• (5), (6)の形式では、 nh は空である、または、(*this).get_allocator() == nh.get_allocator()でなければならない。

効果

• (1) : 引数 v、あるいは rv で指定した値と等価なキーがコンテナに存在していなければ、当該要素を追加する。
• (2) : 引数 v、あるいは rv で指定した値と等価なキーがコンテナに存在していなければ、当該要素を追加する。
  引数 position は、要素の挿入位置を探し始める場所のヒントとして使用されるが、実装によって無視されるかもしれない。
• (3) : イテレータ範囲 [first, last) のすべての要素 t に対して、(1)の形式の insert(t) を呼び出した場合と等価である。
• (4) : (3)の形式を insert(il.begin(), il.end()) として呼び出した場合と等価である。
• (5) : nhが空の場合、効果はない。 それ以外の場合、nh.key()と等価のキーを持つ要素がコンテナにない場合に限り、nhが所有する要素を挿入する。
• (6) : nhが空の場合、効果はなく、(*this).end()を返す。 それ以外の場合、nh.key()と等価のキーを持つ要素がコンテナにない場合に限り、nhが所有する要素を挿入する。nh.key()と等価のキーの要素を指すイテレータを常に返す。 要素は、hintの直前の位置のできるだけ近くに挿入される。

戻り値

• (1) : pair の bool 部分（second 部）は、要素が追加されたら true、追加されなかったら（既にあったら）false。
  pair の iterator 部分（first 部）は、追加された要素（bool 部分が true の場合）、あるいは、既にあった要素（bool 部分が false の場合）を指すイテレータ。
• (2) : 新たな要素が追加された場合、その追加された要素を指すイテレータ。
  新たな要素が追加されなかった場合、既にあった要素を指すイテレータ。
• (3) : なし
• (4) : なし
• (5) : 戻り値としては、insert_return_typeを返す。insert_return_typeのイテレータ型メンバ変数position、bool型メンバ変数insertedに格納される値は(1), (2)のものと同じ情報である。nhが空の場合は、positionは終端イテレータである。node_type型メンバ変数nodeには、
  • 挿入された場合には、空のノードハンドル。
  • 挿入されなかった場合には、nhの値である。
• (6) : nhが空の場合、(*this).end()を返す。そうではない場合、nhと等価のキーの要素を指すイテレータを常に返す。

例外

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

計算量

• (1) : 平均的なケースでは定数（O(1)）だが、最悪のケースではコンテナの要素数 size() に比例（O(N)）。
• (2) : 平均的なケースでは定数（O(1)）だが、最悪のケースではコンテナの要素数 size() に比例（O(N)）。
• (3) : 平均的なケースでは引数の範囲の要素数 std::distance(first, last) に比例（O(N)）するが、最悪のケースでは引数の範囲の要素数 std::distance(first, last) とコンテナの要素数 size() に 1 加えたものの積に比例（O(std::distance(first, last) * (size() + 1))）。

• (4) : (3)の形式を insert(il.begin(), il.end()) として呼び出した場合と等価。

• (5), (6) : 平均的なケースでは O(1)、最悪のケースでは O(size())。

備考

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

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

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

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

• (5), (6) の場合、要素はコピーもムーブもされない。

例

#include <iostream>
#include <unordered_set>
#include <forward_list>
#include <iterator>
#include <algorithm>
#include <string>

template <class C>
void print(const std::string& label, const C& c)
{
  std::cout << label << " : ";
  std::copy(c.begin(), c.end(), std::ostream_iterator<typename C::value_type>(std::cout, " "));
  std::cout << std::endl;
}

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

  // 一つの要素を挿入（(1)の形式）
  {
    std::unordered_set<int> us{ 0, 1, 2, 3, 4, 5, };

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

  // 一つの要素を挿入（(2)の形式）
  {
    std::unordered_set<int> us{ 0, 1, 2, 3, 4, 5, };

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

  // 複数の要素を挿入（(3)の形式）
  {
    std::unordered_set<int> us{ 0, 1, 2, 3, 4, 5, };

    std::forward_list<int> fl{ 5, 6, 0, 8, 7, };
    us.insert(fl.cbegin(), fl.cend()); // forward_list の要素を全部
    print("insert range", us);
  }

  // 複数の要素を挿入（(4)の形式）
  {
    std::unordered_set<int> us{ 0, 1, 2, 3, 4, 5, };

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

出力

true 6 false 2
insert one element : 6 5 4 3 2 1 0
6 2
insert one element with hint : 6 5 4 3 2 1 0
insert range : 7 8 6 5 4 3 2 1 0
insert initializer_list : 7 8 6 5 4 3 2 1 0

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

バージョン

言語

• C++11

処理系

• Clang: 3.1 ✅
• GCC: 4.7.0 ✅
• ICC: ?
• Visual C++: ?

実装例

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

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

template <class Key, class Hash, class Pred, class Allocator>
inline iterator unordered_set<Key, Hash, Pred, Allocator>::insert(const_iterator, value_type&& rv)
{
  return insert(std::move(rv)).first;
}

template <class Key, class Hash, class Pred, class Allocator>
template <class InputIterator>
inline void unordered_set<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_set<Key, Hash, Pred, Allocator>::insert(initializer_list<Key> il);
{
  insert(il.begin(), il.end());
}

関連項目

参照

• N2350 Container insert/erase and iterator constness (Revision 1)
• N2679 Initializer Lists for Standard Containers(Revision 1)
  • (4)の経緯となる提案文書
• Splicing Maps and Sets(Revision 5)
  • (5), (6)経緯となる提案文書