std::unorde...imap::insert(3)

💅 NAME 💅

std::unordered_multimap::insert — std::unordered_multimap::insert. bestie, yes the name is doing a little echo thing, iykyk 💀. This is the std::unordered_multimap::insert(3) page from the C++ Standard Libary manual, and we're gonna get you comfy with every single overload. no skipping, periodt.

✨ Synopsis ✨

          Defined in header <unordered_map>
          iterator insert( const value_type& value );                      (1)
       (since C++11)
          iterator insert( value_type&& value );                           (2)
       (since C++17)
          template< class P >                                              (3)
       (since C++11)
          iterator insert( P&& value );
          iterator insert( const_iterator hint, const value_type& value ); (4)
       (since C++11)
          iterator insert( const_iterator hint, value_type&& value );      (5)
       (since C++17)
          template< class P >                                              (6)
       (since C++11)
          iterator insert( const_iterator hint, P&& value );
          template< class InputIt >                                        (7)
       (since C++11)
          void insert( InputIt first, InputIt last );
          void insert( std::initializer_list<value_type> ilist );          (8)
       (since C++11)
          iterator insert( node_type&& nh );                               (9)
       (since C++17)
          iterator insert( const_iterator hint, node_type&& nh );          (10)
       (since C++17)

okay so the whole gig: this inserts element(s) into the container ✨.

• 1–3 — inserts value. Overload (3) is equivalent to emplace(std::forward<P>(value)) and only participates in overload resolution if std::is_constructible<value_type, P&&>::value == true.
• 4–6 — inserts value, using hint as a non-binding suggestion to where the search should start. Overload (6) is equivalent to emplace_hint(hint, std::forward<P>(value)) and only participates in overload resolution if std::is_constructible<value_type, P&&>::value == true.
• 7 — inserts elements from range [first, last). If [first, last) is not a valid range, or first and/or last are iterators into *this, the behavior is undefined. that's UB, bestie — do not.
• 8 — inserts elements from initializer list ilist.
• 9 — if nh is an empty node handle, does nothing. Otherwise, inserts the element owned by nh into the container and returns an iterator pointing at the inserted element. The behavior is undefined if nh is not empty and get_allocator() != nh.get_allocator().
• 10 — if nh is an empty node handle, does nothing and returns the end iterator. Otherwise, inserts the element owned by nh into the container, and returns the iterator pointing to the element with key equivalent to nh.key(). hint is used as a non-binding suggestion to where the search should start. The behavior is undefined if nh is not empty and get_allocator() != nh.get_allocator().

⚠️ If after the operation the new number of elements is greater than old max_load_factor() * bucket_count() a rehashing takes place. If rehashing occurs (due to the insertion), all iterators are invalidated. Otherwise (no rehashing), iterators are not invalidated. If the insertion is successful, pointers and references to the element obtained while it is held in the node handle are invalidated, and pointers and references obtained to that element before it was extracted become valid. (since C++17)

🌸 Parameters 🌸

• hint — iterator, used as a suggestion as to where to insert the content
• value — element value to insert
• first, last — range of elements to insert
• ilist — initializer list to insert the values from
• nh — a compatible node handle

🧚 Type requirements 🧚

• InputIt must meet the requirements of LegacyInputIterator.

🎀 Return value 🎀

• 1–6 — an iterator to the inserted element.
• 7, 8 — (none).
• 9, 10 — end iterator if nh was empty, iterator pointing to the inserted element otherwise.

💀 Exceptions 💀

• 1–6 — if an exception is thrown for any reason, these functions have no effect (strong exception safety guarantee).
• 7, 8 — no exception safety guarantee.
• 9, 10 — if an exception is thrown for any reason, these functions have no effect (strong exception safety guarantee).

⏱️ Complexity ⏱️

• 1–6 — average case: O(1), worst case O(size()).
• 7, 8 — average case: O(N), where N is the number of elements to insert. Worst case: O(N * size() + N).
• 9, 10 — average case: O(1), worst case O(size()).

🧪 Example 🧪

This section is incomplete Reason: no example

🐞 Defect reports 🐞

the following behavior-changing defect reports were applied retroactively to previously published C++ standards — yes, the committee came back later like “actually…” and honestly, iconic.

• DR LWG 2005 — applied to C++11. Behavior as published: overloads (3,6) would only participate in overload resolution if P is implicitly convertible to value_type. Correct behavior: only participates if value_type is constructible from P&&.

👀 See also 👀

• emplace — constructs element in-place (public member function)
• emplace_hint — constructs elements in-place using a hint (public member function)
• inserter — creates a std::insert_iterator of type inferred from the argument (function template)

🏷️ Category 🏷️

• * Todo no example

---

okay bestie, that's the whole page 🫶 source/version + date: http://cppreference.com · 2024.06.10 💖✨