(C++17) | ||||
Sequence | ||||
(C++11) | ||||
(C++26) | ||||
(C++26) | ||||
(C++11) | ||||
Associative | ||||
Unordered associative | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
(C++11) | ||||
Adaptors | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
Views | ||||
(C++20) | ||||
(C++23) | ||||
Tables | ||||
Iterator invalidation | ||||
Member function table | ||||
Non-member function table |
Member types | ||||||
Member functions | ||||||
Non-member functions | ||||||
| ||||||
Deduction guides(C++17) |
std::pair<iterator,bool> insert(const value_type& value); | (1) | (since C++11) |
std::pair<iterator,bool> insert( value_type&& value); | (2) | (since C++17) |
template<class P> std::pair<iterator,bool> 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) |
insert_return_type 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, if the container doesn't already contain an element with an equivalent key.
[
first,
last)
. If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pendingLWG2844).[
first,
last)
is not avalid range, orfirst and/orlast are iterators into*this, the behavior is undefined.If after the operation the new number of elements is greater than oldmax_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 |
hint | - | iterator, used as a suggestion as to where to insert the content |
value | - | element value to insert |
first, last | - | the pair of iterators defining the sourcerange of elements to insert |
ilist | - | initializer list to insert the values from |
nh | - | a compatiblenode handle |
Type requirements | ||
-InputIt must meet the requirements ofLegacyInputIterator. |
insert_return_type
with the members initialized as follows:inserted
isfalse,position
isend(), andnode
is empty.inserted
istrue,position
points to the inserted element, andnode
is empty.inserted
isfalse,node
has the previous value ofnh, andposition
points to an element with a key equivalent tonh.key().O(1)
, worst caseO(size())
.O(N)
, where N is the number of elements to insert. Worst case:O(N * size() + N)
.O(1)
, worst caseO(size())
.The hinted insert((4-6) and(10))does not return a boolean in order to be signature-compatible with positional insert on sequential containers, such asstd::vector::insert. This makes it possible to create generic inserters such asstd::inserter. One way to check success of a hinted insert is to comparesize()
before and after.
#include <iostream>#include <string>#include <unordered_map> int main(){std::unordered_map<int,std::string> dict={{1,"one"},{2,"two"}}; dict.insert({3,"three"}); dict.insert(std::make_pair(4,"four")); dict.insert({{4,"another four"},{5,"five"}}); constbool ok= dict.insert({1,"another one"}).second;std::cout<<"inserting 1 =>\"another one\" "<<(ok?"succeeded":"failed")<<'\n'; std::cout<<"contents:\n";for(auto& p: dict)std::cout<<' '<< p.first<<" => "<< p.second<<'\n';}
Possible output:
inserting 1 => "another one" failedcontents: 5 => five 1 => one 2 => two 3 => three 4 => four
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) and(6) would only participate in overload resolution if P is implicitly convertible tovalue_type | only participates ifvalue_type is constructible fromP&& |
constructs element in-place (public member function)[edit] | |
constructs elements in-place using a hint (public member function)[edit] | |
(C++17) | inserts an element or assigns to the current element if the key already exists (public member function)[edit] |
creates astd::insert_iterator of type inferred from the argument (function template)[edit] |