Namespaces
Variants
Views
Actions

std::flat_set<Key,Compare,KeyContainer>::insert

From cppreference.com
< cpp‎ | container‎ | flat set
 
 
 
 
std::pair<iterator, bool> insert( const value_type& value );
(1) (since C++23)
std::pair<iterator, bool> insert( value_type&& value );
(2) (since C++23)
iterator insert( const_iterator pos, const value_type& value );
(3) (since C++23)
iterator insert( const_iterator pos, value_type&& value );
(4) (since C++23)
template< class K >
iterator insert( const_iterator pos, K&& x );
(5) (since C++23)
template< class InputIt >
void insert( InputIt first, InputIt last );
(6) (since C++23)
template< class K >
std::pair<iterator, bool> insert( K&& x );
(7) (since C++23)
template< class InputIt >
void insert( std::sorted_unique_t, InputIt first, InputIt last );
(8) (since C++23)
void insert( std::initializer_list<key_type> ilist );
(9) (since C++23)
void insert( std::sorted_unique_t s, std::initializer_list<key_type> ilist );
(10) (since C++23)

Inserts element(s) into the container, if the container does not already contain an element with an equivalent key.

1) Inserts value. Equivalent to return emplace(value);.
2) Inserts value. Equivalent to return emplace(std::move(value));.
3) Inserts value in the position as close as possible to the position just prior to pos. Equivalent to return emplace_hint(pos, value);.
4) Inserts value in the position as close as possible to the position just prior to pos. Equivalent to return emplace_hint(pos, std::move(value));.
5) If *this already contains an element which transparently compares equivalent to x, does nothing. Otherwise, constructs an object u of the value_type with std::forward<K>(x) and then inserts u into *this in the position as close as possible to the position just prior to pos.
If equal_range(u) == equal_range(x) is false, the behavior is undefined.
The value_type must be EmplaceConstructible into flat_set from std::forward<K>(x).
This overload participates in overload resolution only if: which together allows calling this function without constructing an instance of Key.
6) Inserts elements from range [firstlast) as if performing the following operations sequentially:
  1. Adds elements to c as if by c.insert(c.end(), first, last);.
  2. Sorts the range of newly inserted elements with respect to compare.
  3. Merges the resulting sorted range and the sorted range of pre-existing elements into a single sorted range.
  4. Erases all but the first element from each group of consecutive equivalent elements.
May allocate memory during the in-place merge operation.
If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).
7) If *this already contains an element which transparently compares equivalent to x, does nothing. Otherwise, constructs an object u of the value_type with std::forward<K>(x) and then inserts u into *this.
If equal_range(u) == equal_range(x) is false, the behavior is undefined.
The value_type must be EmplaceConstructible into set from std::forward<K>(x).
This overload participates in overload resolution only if the qualified-id Compare::is_transparent is valid and denotes a type. It allows calling this function without constructing an instance of Key.
8) Inserts elements from range [firstlast). Equivalent to insert(first, last);.
If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).
9) Inserts elements from initializer list ilist. Equivalent to insert(ilist.begin(), ilist.end());.
If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).
10) Inserts elements from initializer list ilist. Equivalent to insert(s, ilist.begin(), ilist.end());.
If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).

Contents

[edit] Parameters

pos - iterator to the position before which the new element will be inserted
value - element value to insert
first, last - range of elements to insert
ilist - initializer list to insert the values from
x - a value of any type that can be transparently compared with a key
s - a disambiguation tag indicating that the input sequence is sorted (with respect to key_compare) and contains only unique elements
Type requirements
-
InputIt must meet the requirements of LegacyInputIterator.

[edit] Return value

1,2) A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool value set to true if and only if the insertion took place.
3-5) An iterator to the inserted element, or to the element that prevented the insertion.
6) (none)
7) A pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool value set to true if and only if the insertion took place.
8-10) (none)

[edit] Exceptions

1-5,7) If an exception is thrown by any operation, the insertion has no effect.

[edit] Complexity

1-5) Linear in size().
6) N + M·log(M), where N is the size() before the operation and M is std::distance(first, last).
7) Linear in size().
8) Linear in N, where N is size() after the operation.
9) N + M·log(M), where N is the size() before the operation and M is ilist.size().
10) Linear in N, where N is size() after the operation.

[edit] Notes

The hinted insert (3-5) does not return a boolean in order to be signature-compatible with positional insert on sequential containers, such as std::vector::insert. This makes it possible to create generic inserters such as std::inserter. One way to check success of a hinted insert is to compare size() before and after.

[edit] Example

#include <cassert>
#include <flat_set>
#include <iostream>
 
int main()
{
    std::flat_set<int> set;
 
    auto result_1 = set.insert(3);
    assert(result_1.first != set.end()); // it is a valid iterator
    assert(*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); // the same iterator
    assert(*result_2.first == 3);
    if (!result_2.second)
        std::cout << "no insertion\n";
}

Output:

insert done
no insertion

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