(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 functions | |||||||
| Non-member functions | |||||||
| |||||||
| Deduction guides(C++17) | |||||||
std::pair<iterator,bool> insert(const value_type& value); | (1) | (constexpr since C++26) |
std::pair<iterator,bool> insert( value_type&& value); | (2) | (since C++11) (constexpr since C++26) |
| (3) | ||
iterator insert( iterator pos,const value_type& value); | (until C++11) | |
iterator insert( const_iterator pos,const value_type& value); | (since C++11) (constexpr since C++26) | |
iterator insert( const_iterator pos, value_type&& value); | (4) | (since C++11) (constexpr since C++26) |
template<class InputIt> void insert( InputIt first, InputIt last); | (5) | (constexpr since C++26) |
void insert(std::initializer_list<value_type> ilist); | (6) | (since C++11) (constexpr since C++26) |
insert_return_type insert( node_type&& nh); | (7) | (since C++17) (constexpr since C++26) |
iterator insert( const_iterator pos, node_type&& nh); | (8) | (since C++17) (constexpr since C++26) |
template<class K> std::pair<iterator,bool> insert( K&& x); | (9) | (since C++23) (constexpr since C++26) |
template<class K> iterator insert( const_iterator pos, K&& x); | (10) | (since C++23) (constexpr since C++26) |
Attempts to insert element(s) into*this.
| (since C++11) |
[first, last).
| (since C++11) |
value_type withstd::forward<K>(x) and then insertsu into*this. The existence of the equivalent key is determined transparently usingx before constructingu.value_type is notEmplaceConstructible intoset fromstd::forward<K>(x).Compare istransparent.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 the sourcerange of elements to insert |
| ilist | - | initializer list to insert the values from |
| nh | - | a compatiblenode handle |
| x | - | a value of any type that can be transparently compared with a key |
| 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().If an exception is thrown by any operation during the insertion of a single element, the insertion has no effect.
Given\(\scriptsize N\)N assize():
The hinted insert((3,4),(8) 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.
The overloads(5,6) are often implemented as a loop that calls the overload(3) withend() as the hint; they are optimized for appending a sorted sequence (such as anotherstd::set) whose smallest element is greater than the last element in*this.
If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pendingLWG2844).
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_associative_heterogeneous_insertion | 202311L | (C++26) | Heterogeneous overloads for the remaining member functions inordered andunordered associative containers.(9,10) |
#include <cassert>#include <iostream>#include <set> int main(){std::set<int> set; auto result_1= set.insert(3);assert(result_1.first!= set.end());// it is a valid iteratorassert(*result_1.first==3);if(result_1.second)std::cout<<"insert done\n"; auto result_2= set.insert(3);assert(result_2.first== result_1.first);// same iteratorassert(*result_2.first==3);if(!result_2.second)std::cout<<"no insertion\n";}
Output:
insert doneno insertion
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(5) 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 |
(C++11) | constructs element in-place (public member function)[edit] |
(C++11) | constructs elements in-place using a hint (public member function)[edit] |
| creates astd::insert_iterator of type inferred from the argument (function template)[edit] |