Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/container/unordered multimap/insert"

From cppreference.com
(cleanup)
m
 
(14 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{cpp/container/unordered_multimap/title | insert}}
+
{{cpp/container/unordered_multimap/title|insert}}
 
{{cpp/container/unordered_multimap/navbar}}
 
{{cpp/container/unordered_multimap/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
{{dcl | num=1 | since=c++11 |
+
{{dcl header|unordered_map}}
 +
{{dcl|num=1|since=c++11|
 
iterator insert( const value_type& value );
 
iterator insert( const value_type& value );
 
}}
 
}}
{{dcl | num=2 | since=c++11 |
+
{{dcl|num=2|since=c++17|
 +
iterator insert( value_type&& value );
 +
}}
 +
{{dcl|num=3|since=c++11|
 
template< class P >
 
template< class P >
 
iterator insert( P&& value );
 
iterator insert( P&& value );
 
}}
 
}}
{{dcl | num=3 | since=c++11 |
+
{{dcl|num=4|since=c++11|
 
iterator insert( const_iterator hint, const value_type& value );
 
iterator insert( const_iterator hint, const value_type& value );
 
}}
 
}}
{{dcl | num=4 | since=c++11 |
+
{{dcl|num=5|since=c++17|
 +
iterator insert( const_iterator hint, value_type&& value );
 +
}}
 +
{{dcl|num=6|since=c++11|
 
template< class P >
 
template< class P >
 
iterator insert( const_iterator hint, P&& value );
 
iterator insert( const_iterator hint, P&& value );
 
}}
 
}}
{{dcl | num=5 | since=c++11 |
+
{{dcl|num=7|since=c++11|
 
template< class InputIt >
 
template< class InputIt >
 
void insert( InputIt first, InputIt last );
 
void insert( InputIt first, InputIt last );
 
}}
 
}}
{{dcl | num=6 | since=c++11 |
+
{{dcl|num=8|since=c++11|
 
void insert( std::initializer_list<value_type> ilist );
 
void insert( std::initializer_list<value_type> ilist );
 +
}}
 +
{{dcl|num=9|since=c++17|
 +
iterator insert( node_type&& nh );
 +
}}
 +
{{dcl|num=10|since=c++17|
 +
iterator insert( const_iterator hint, node_type&& nh );
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
Line 27: Line 40:
 
Inserts element(s) into the container.
 
Inserts element(s) into the container.
  
@1-2@ inserts {{tt|value}}. The overload (2) is equivalent to {{c|emplace(std::forward<P>(value))}} and only participates in overload resolution if {{c|std::is_constructible<value_type, P&&>::value {{==}} true}}.
+
@1-3@ Inserts {{c|value}}.
 +
@@ Overload {{v|3}} is equivalent to {{c|emplace(std::forward<P>(value))}} and only participates in overload resolution if {{c|1=std::is_constructible<value_type, P&&>::value == true}}.
  
@3-4@ inserts {{tt|value}}, using {{tt|hint}} as a non-binding suggestion to where the search should start. The overload (4) is equivalent to {{c|emplace_hint(hint, std::forward<P>(value))}} and only participates in overload resolution if {{c|std::is_constructible<value_type, P&&>::value {{==}} true}}.
+
@4-6@ Inserts {{c|value}}, using {{c|hint}} as a non-binding suggestion to where the search should start.
 +
@@ Overload {{v|6}} is equivalent to {{c|emplace_hint(hint, std::forward<P>(value))}} and only participates in overload resolution if {{c|1=std::is_constructible<value_type, P&&>::value == true}}.
  
@5@ inserts elements from range {{tt|[first, last)}}.
+
@7@ Inserts elements from range {{range|first|last}}.
 +
@@ If {{range|first|last}} is not a [[cpp/iterator#Ranges|valid range]], or {{c|first}} and/or {{c|last}} are iterators into {{c|*this}}, the behavior is undefined.
  
@6@ inserts elements from initializer list {{tt|ilist}}.
+
@8@ Inserts elements from initializer list {{c|ilist}}.
 +
 
 +
{{cpp/container/node handle insert desc|unordered_multimap|9|10}}
 +
 
 +
{{cpp/container/note iterator invalidation|unordered_multimap|insert}}
  
{{cpp/container/note_iterator_invalidation|unordered_multimap|insert}}
 
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
{{par | hint | iterator, used as a suggestion as to where to insert the content}}
+
{{par|hint|iterator, used as a suggestion as to where to insert the content}}
{{par | value | element value to insert}}
+
{{par|value|element value to insert}}
{{par | first, last | range of elements to insert}}
+
{{par|first, last|range of elements to insert}}
{{par | ilist | initializer list to insert the values from}}
+
{{par|ilist|initializer list to insert the values from}}
 +
{{par|nh|a compatible [[cpp/container/node_handle|node handle]]}}
 
{{par hreq}}
 
{{par hreq}}
{{par req concept | InputIt | InputIterator}}
+
{{par req named|InputIt|InputIterator}}
 
{{par end}}  
 
{{par end}}  
  
 
===Return value===
 
===Return value===
@1-4@ Returns an iterator to the inserted element.
+
@1-6@ An iterator to the inserted element.
  
@5-6@ (none)
+
@7,8@ (none)
 +
 
 +
{{cpp/container/node_handle_insert_return|unordered_multimap|9|10}}
  
 
===Exceptions===
 
===Exceptions===
@1-4@ If an exception is thrown by any operation, the insertion has no effect.
+
@1-6@ {{cpp/strong exception safety guarantee|plural=yes}}
  
{{todo|cases 5-6}}
+
@7,8@ No exception safety guarantee.
 +
 
 +
@9,10@ {{cpp/strong exception safety guarantee|plural=yes}}
  
 
===Complexity===
 
===Complexity===
@1-4@ Average case: {{tt|O(1)}}, worst case {{tt|O(size())}}
+
@1-6@ Average case: {{tt|O(1)}}, worst case {{tt|O(size())}}.
 +
 
 +
@7,8@ Average case: {{tt|O(N)}}, where N is the number of elements to insert. Worst case: {{tt|O(N * size() + N)}}.
 +
 
 +
@9,10@ Average case: {{tt|O(1)}}, worst case {{tt|O(size())}}.
 +
 
 +
===Example===
 +
{{example}}
  
@5-6@ Average case: {{tt|O(N)}}, where N is the number of elements to insert. Worse case: {{tt|O(N*size()+N)}}
+
===Defect reports===
 +
{{dr list begin}}
 +
{{dr list item|wg=lwg|dr=2005|std=C++11|before=overloads {{v|3,6}} would only participate in overload<br>resolution if {{tt|P}} is implicitly convertible to {{tt|value_type}}|after=only participates if {{tt|value_type}}<br>is constructible from {{tt|P&&}}}}
 +
{{dr list end}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
{{dsc inc | cpp/container/dsc emplace |unordered_multimap}}
+
{{dsc inc|cpp/container/dsc emplace|unordered_multimap}}
{{dsc inc | cpp/container/dsc emplace_hint |unordered_multimap}}
+
{{dsc inc|cpp/container/dsc emplace_hint|unordered_multimap}}
 +
{{dsc inc|cpp/iterator/dsc inserter}}
 
{{dsc end}}
 
{{dsc end}}
  
[[de:cpp/container/unordered multimap/insert]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
[[es:cpp/container/unordered multimap/insert]]
+
[[fr:cpp/container/unordered multimap/insert]]
+
[[it:cpp/container/unordered multimap/insert]]
+
[[ja:cpp/container/unordered multimap/insert]]
+
[[pt:cpp/container/unordered multimap/insert]]
+
[[ru:cpp/container/unordered multimap/insert]]
+
[[zh:cpp/container/unordered multimap/insert]]
+

Latest revision as of 13:36, 10 January 2024

 
 
 
 
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 >
iterator insert( P&& value );
(3) (since C++11)
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 >
iterator insert( const_iterator hint, P&& value );
(6) (since C++11)
template< class InputIt >
void insert( InputIt first, InputIt last );
(7) (since C++11)
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)

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 [firstlast).
If [firstlast) is not a valid range, or first and/or last are iterators into *this, the behavior is undefined.
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)

Contents

[edit] 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.

[edit] 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.

[edit] 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).

[edit] 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()).

[edit] Example

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

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

[edit] See also

constructs element in-place
(public member function) [edit]
constructs elements in-place using a hint
(public member function) [edit]
creates a std::insert_iterator of type inferred from the argument
(function template) [edit]