最終更新日時: 2026年03月21日 23時12分53秒 (JST)
Raclamusi が更新

履歴 編集

function
<unordered_map>

# std::unordered_multimap::insert(C++11)

    iterator insert(const value_type& v);           // (1) C++11
    constexpr iterator insert(const value_type& v); // (1) C++26

    iterator insert(value_type&& v);           // (2) C++17
    constexpr iterator insert(value_type&& v); // (2) C++26

    template <class P>
    iterator insert(P&& obj);           // (3) C++11
    template <class P>
    constexpr iterator insert(P&& obj); // (3) C++26

    iterator insert(const_iterator position, const value_type& v);           // (4) C++11
    constexpr iterator insert(const_iterator position, const value_type& v); // (4) C++26

    iterator insert(const_iterator hint, value_type&& v);           // (5) C++17
    constexpr iterator insert(const_iterator hint, value_type&& v); // (5) C++26

    template <class P>
    iterator insert(const_iterator position, P&& obj);           // (6) C++11
    template <class P>
    constexpr iterator insert(const_iterator position, P&& obj); // (6) C++26

    template <class InputIterator>
    void insert(InputIterator first, InputIterator last);           // (7) C++11
    template <class InputIterator>
    constexpr void insert(InputIterator first, InputIterator last); // (7) C++26

    void insert(initializer_list<value_type> il);           // (8) C++11
    constexpr void insert(initializer_list<value_type> il); // (8) C++26

    iterator insert(node_type&& nh);           // (9) C++17
    constexpr iterator insert(node_type&& nh); // (9) C++26

    iterator insert(const_iterator hint, node_type&& nh);           // (10) C++17
    constexpr iterator insert(const_iterator hint, node_type&& nh); // (10) C++26

## 概要

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

## 要件

- (1), (4) : `value_type` はこのコンテナに対してコピー挿入可能であること
- (2), (5) : `value_type` はこのコンテナに対してムーブ挿入可能であること
- (3), (6) :
  - `value_type` は引数 `obj` からこのコンテナに対して直接構築可能であること
  - 引数 `position` は、このコンテナの有効な読み取り専用イテレータであること
  - `std::constructible_from<value_type, P&&>`要件を満たすこと
    - なお、C++11 では「`P` が `value_type` に暗黙変換可能」という、より厳しい条件の記載になってしまっていた。これは規格の誤りとして C++14 で修正されたが、使用する処理系やバージョンによる挙動の差異に注意が必要である
- (7) :
  - 引数 `first`、および、`last`は、入力イテレータの要件を満たし、参照先の要素は `value_type` 型で、かつ、イテレータ範囲 `[first, last)` が当該コンテナ 以外を指す 有効な範囲であること
  - このコンテナの要素型 `value_type` は、コンテナに対して `*first` から直接構築可能であること
- (8) : `value_type` はこのコンテナに対してコピー挿入可能であること
- (9), (10)の形式では、 `nh` は空である、または、`(*this).get_allocator() == nh.get_allocator()`でなければならない。

## 効果

- (1), (2) :
  - 引数 `v` で指定した値の要素を追加する
- (3) :
  - 引数 `obj` から構築されたオブジェクト `v` を追加する
  - このバージョンの動作は、`emplace(std::forward<P>(obj))` を呼び出した場合と等価である
- (4), (5) :
  - 引数 `v` で指定した値の要素を追加する
  - 引数 `position` は、要素の挿入位置を探し始める場所のヒントとして使用されるが、実装によって無視されるかもしれない
- (6) :
  - 引数 `obj` から構築されたオブジェクト `v` を追加する
  - 引数 `position` は、要素の挿入位置を探し始める場所のヒントとして使用されるが、実装によって無視されるかもしれない
  - このバージョンの動作は、`emplace_hint(hint, std::forward<P>(obj))` を呼び出した場合と等価である
- (7) :
  - イテレータ範囲 `[first, last)` のすべての要素 `t` に対して、`insert(t)` を呼び出した場合と等価である（`*first` の型によって (1)、あるいは(2)の形式が呼び出される）
- (8) :
  - (7)の形式を `insert(il.begin(), il.end())` として呼び出した場合と等価である
- (9) :
  - `nh`が空の場合、効果はない
  - そうでなければ、`nh`が所有する要素を挿入し、新しく挿入された要素を指すイテレータを返す
  - `nh.key()` と等価なキーを持つ要素を含む範囲がコンテナ内に存在する場合、要素はその範囲の終端に挿入される
- (10) :
  - `nh`が空の場合、効果はなく、`(*this).end()`を返す
  - そうでなければ、 `nh` によって所有されている要素をコンテナに挿入し、 `nh.key()` と等価なキーを持つ要素を指すイテレータを返す
  - `nh.key()` と等しいキーを持つ要素を含む範囲がコンテナ内に存在する場合、要素はその範囲の終端に挿入される。要素は、`hint`の直前の位置のできるだけ近くに挿入される

## 戻り値

- (1)から(6) : 追加された要素を指すイテレータを返す
- (7), (8) : なし
- (9), (10) : `nh` が空の場合は終端イテレータ、そうでなければ挿入された要素を指すイテレータを返す

## 例外

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

## 計算量

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

## 備考

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

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

  - これらの関数を呼び出した後の要素数が、呼び出す前のバケット数（`bucket_count()` の戻り値）×最大負荷率（`max_load_factor()` の戻り値）以下である。

  となっている。
  なお、この条件は C++14 までは「以下」ではなく「よりも小さい」だったため、最大負荷率の定義と不整合だった。
  これは規格の誤りとして C++17 で修正されたが、使用する処理系やそのバージョンによっては以前の「よりも小さい」という条件でしかイテレータの有効性を保証していない可能性があるため、注意が必要である。

- これらの関数が呼ばれた後、たとえ呼び出しの前後でこのコンテナのバケット数（`bucket_count()` の戻り値）が変わった（＝リハッシュが発生した）場合でも、等価なキーの要素同士の相対的な順序は変わらない。

- (4), (5), (6) :
  - 本関数呼び出しで構築されるオブジェクトを `t` とすると、`t.first` と等価なキーの要素が既に存在する場合、`position` に応じて既存の要素と新規の要素が順序付けられると期待されるが、規格書にそのような規定は存在しない。従って、そのような期待はすべきではない。`emplace_hint` も参照。
  - 引数 `position` は、C++14 までは間接参照可能（dereferenceable）でなければならない（つまり、`cend()` ではいけない）との記載になっていたが、これは規格の誤りとして C++17 で修正された。
- 上記の要件に示したように、`first`、および、`last` の参照先の要素は `value_type` 型でなければならないとされているが、その要件を満たさなくてももう一つの要件である直接構築可能を満たすだけで十分にライブラリを実装可能と思われる。
  実際、Clang(libc++) は `first`、および、`last` の参照先の要素が `value_type` 型でなくとも (7) の形式を使用可能である。
- (9), (10) の場合、要素はコピーもムーブもされない。

## 例

    #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()
    {
      // 一つの要素を挿入（(1), (2)の形式）
      {
        std::unordered_multimap<int, std::string> um{ {0, "zero"}, {1, "one"}, {2, "two"}, {3, "three"}, {4, "four"}, {5, "five"}, };

        auto it1 = um.insert(cis{6, "6th"}); // 重複のないケース
        std::cout << *it1 << ' ';
        auto it2 = um.insert(cis{2, "2nd"}); // 重複のあるケース
        std::cout << *it2 << std::endl;
        ::print("insert one element", um);
      }

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

        auto it1 = um.insert(is{6, "6th"}); // 重複のないケース
        std::cout << *it1 << ' ';
        auto it2 = um.insert(is{2, "2nd"}); // 重複のあるケース
        std::cout << *it2 << std::endl;
        ::print("insert one element", um);
      }

      // 一つの要素を挿入（(4), (5)の形式）
      {
        std::unordered_multimap<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);
      }

      // 一つの要素を挿入（(6)の形式）
      {
        std::unordered_multimap<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);
      }

      // 複数の要素を挿入（(7)の形式）
      {
        std::unordered_multimap<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);
      }

      // 複数の要素を挿入（(8)の形式）
      {
        std::unordered_multimap<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);
      }
    }

### 出力例

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

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

## バージョン

### 言語

- C++11

### 処理系

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

### 備考

- Clang 3.3 以降は C++17 モードでなくても C++17 の条件でのリハッシュとなっている。
- GCC は 8.2.0 時点でまだ C++17 の条件でのリハッシュとなっていない。また、バージョンによってリハッシュ条件が微妙に異なるため注意。
- (9), (10) の場合、要素はコピーもムーブもされない。

## 実装例

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

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

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

    template <class Key, class Hash, class Pred, class Allocator>
    template <class InputIterator>
    inline void unordered_multimap<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_multimap<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` | 最小要素数指定によるバケット数の調整

## 参照

- N2350 Container insert/erase and iterator constness (Revision 1)
- N2679 Initializer Lists for Standard Containers(Revision 1)
  - (8)の経緯となる提案文書
- LWG Issue 518. Are `insert` and `erase` stable for `unordered_multiset` and `unordered_multimap`?
  - 安定性の保証が規定された経緯のレポート
- LWG Issue 2005. `unordered_map::insert(T&&)` protection should apply to `map` too
- LWG Issue 2540. unordered_multimap::insert hint iterator
- LWG Issue 2156. Unordered containers' reserve(n) reserves for n-1 elements
- Splicing Maps and Sets(Revision 5)
  - (9), (10)経緯となる提案文書
- How useful is the hint passed to the std::unordered_... collections? - The Old New Thing
- P3372R3 constexpr containers and adaptors