(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 |
std::map
Member functions | |||||||
Non-member functions | |||||||
| |||||||
Deduction guides(C++17) |
std::pair<iterator,bool> insert(const value_type& value); | (1) | |
template<class P> std::pair<iterator,bool> insert( P&& value); | (2) | (since C++11) |
std::pair<iterator,bool> insert( value_type&& value); | (3) | (since C++17) |
(4) | ||
iterator insert( iterator pos,const value_type& value); | (until C++11) | |
iterator insert( const_iterator pos,const value_type& value); | (since C++11) | |
template<class P> iterator insert( const_iterator pos, P&& value); | (5) | (since C++11) |
iterator insert( const_iterator pos, value_type&& value); | (6) | (since C++17) |
template<class InputIt> void insert( InputIt first, InputIt last); | (7) | |
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 pos, 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).No iterators or references are 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 |
pos | - | iterator to the position before which the new element will be inserted |
value | - | element value to insert |
first, last | - | the pair of iterators defining therange 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().This section is incomplete Reason: cases 7-10 |
O(log(size()))
.O(N·log(size() + N))
, whereN
is the number of elements to insert.O(log(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 <iomanip>#include <iostream>#include <map>#include <string>usingnamespace std::literals; template<typename It>void print_insertion_status(It it,bool success){std::cout<<"Insertion of "<< it->first<<(success?" succeeded\n":" failed\n");} int main(){std::map<std::string,float> heights; // Overload 3: insert from rvalue referenceconstauto[it_hinata, success]= heights.insert({"Hinata"s,162.8}); print_insertion_status(it_hinata, success); {// Overload 1: insert from lvalue referenceconstauto[it, success2]= heights.insert(*it_hinata); print_insertion_status(it, success2);}{// Overload 2: insert via forwarding to emplaceconstauto[it, success]= heights.insert(std::pair{"Kageyama",180.6}); print_insertion_status(it, success);}{// Overload 6: insert from rvalue reference with positional hintconststd::size_t n=std::size(heights);constauto it= heights.insert(it_hinata,{"Azumane"s,184.7}); print_insertion_status(it,std::size(heights)!= n);}{// Overload 4: insert from lvalue reference with positional hintconststd::size_t n=std::size(heights);constauto it= heights.insert(it_hinata,*it_hinata); print_insertion_status(it,std::size(heights)!= n);}{// Overload 5: insert via forwarding to emplace with positional hintconststd::size_t n=std::size(heights);constauto it= heights.insert(it_hinata,std::pair{"Tsukishima",188.3}); print_insertion_status(it,std::size(heights)!= n);} auto node_hinata= heights.extract(it_hinata);std::map<std::string,float> heights2; // Overload 7: insert from iterator range heights2.insert(std::begin(heights),std::end(heights)); // Overload 8: insert from initializer_list heights2.insert({{"Kozume"s,169.2},{"Kuroo",187.7}}); // Overload 9: insert nodeconstauto status= heights2.insert(std::move(node_hinata)); print_insertion_status(status.position, status.inserted); node_hinata= heights2.extract(status.position);{// Overload 10: insert node with positional hintconststd::size_t n=std::size(heights2);constauto it= heights2.insert(std::begin(heights2), std::move(node_hinata)); print_insertion_status(it,std::size(heights2)!= n);} // Print resulting mapstd::cout<<std::left<<'\n';for(constauto&[name, height]: heights2)std::cout<<std::setw(10)<< name<<" | "<< height<<"cm\n";}
Output:
Insertion of Hinata succeededInsertion of Hinata failedInsertion of Kageyama succeededInsertion of Azumane succeededInsertion of Hinata failedInsertion of Tsukishima succeededInsertion of Hinata succeededInsertion of Hinata succeeded Azumane | 184.7cmHinata | 162.8cmKageyama | 180.6cmKozume | 169.2cmKuroo | 187.7cmTsukishima | 188.3cm
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 233 | C++98 | pos was just a hint, it could be totally ignored | the insertion is required to be as close as possible to the position just prior topos |
LWG 264 | C++98 | the complexity of overload(7) was required to be linear if the range [ first, last) is sorted according toCompare | removed the linear requirement in this special case |
LWG 316 | C++98 | in the return value of overload(1), it was not specified whichbool value indicates a successful insertion | success is indicated bytrue |
LWG 2005 | C++11 | overloads(2) and(5) were poorly described | improved the description |
(C++11) | constructs element in-place (public member function)[edit] |
(C++11) | 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] |