Skip to main content

std::set insert() method

// (1) Non const version only
std::pair<iterator, bool> insert( value_type&& value );

// (2) Non const version only
std::pair<iterator, bool> insert( value_type&& value );

// (3) Non const version only
iterator insert( const_iterator hint, const value_type& value );

// (4) Non const version only
iterator insert( const_iterator hint, value_type&& value );

// (5) Non const version only
template< class InputIt >
void insert( InputIt first, InputIt last );

// (6) Non const version only
void insert( std::initializer_list<value_type> ilist );

// (7) Non const version only
insert_return_type insert( node_type&& nh );

// (8) Non const version only
iterator insert( const_iterator hint, node_type&& nh );

Inserts element(s) into the container, if the container doesn't already contain an element with an equivalent key.

  • (1-2) Inserts value.

  • (3-4)

    Inserts value in the position as close as possible, just prior to hint.

  • (5) Inserts elements from range [ first; last ).

    If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).

  • (6) Inserts elements from initializer list ilist.

    If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).

  • (7) If nh is an empty node handle, does nothing.

    Otherwise, inserts the element owned by nh into the container, if the container doesn't already contain an element with a key equivalent to nh.key().

Undefined behaviour

The behavior is undefined if nh is not empty and get_allocator() != nh.get_allocator().

  • (8) If nh is an empty node handle, does nothing and returns the end iterator.

    Otherwise, inserts the element owned by nh into the container, if the container doesn't already contain an element with a key equivalent to nh.key(), and returns the iterator pointing to the element with key equivalent to nh.key() (regardless of whether the insert succeeded or failed).

    If the insertion succeeds, nh is moved from, otherwise it retains ownership of the element. The element is inserted as close as possible to hint.

Undefined behaviour

The behavior is undefined if nh is not empty and get_allocator() != nh.get_allocator().

Invalidation

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.

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​

Return value​

  • (1-2) Returns a pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place (true if insertion happened, false if it did not).
  • (3-4) Returns an iterator to the inserted element, or to the element that prevented the insertion.
  • (5-6) (none)
  • (7) Returns an insert_return_type with the members initialized as follows:
    • If nh is empty, inserted is false, position is end(), and node is empty.
    • Otherwise if the insertion took place, inserted is true, position points to the inserted element, and node is empty.
    • If the insertion failed, inserted is false, node has the previous value of nh, and position points to an element with a key equivalent to nh.key().
  • (8) End iterator if nh was empty, iterator pointing to the inserted element if insertion took place, and iterator pointing to an element with a key equivalent to nh.key() if it failed.

Complexity​

  • (1-2) Logarithmic in the size of the container - O(log size()).

  • (3-4)

    Amortized constant if the insertion happens in the position just before the hint - O(1).
    Logarithmic in the size of the container otherwise - O(log size()).

  • (5-6) O(N * log(size() + N)), where N is the number of elements to insert.

  • (7) Logarithmic in the size of the container - O(log size()).

  • (8)
    Amortized constant if the insertion happens in the position just before hint - O(1), Logarithmic in the size of the container otherwise - O(log size()).

Exceptions​

  • (1-4) If an exception is thrown by any operation, the insertion has no effect.
important

This section requires improvement. You can help by editing this doc page.

Notes​

The hinted insert (3-4) 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.

The overloads (5-6) are often implemented as a loop that calls the overload (3) with end() as the hint; they are optimized for appending a sorted sequence (such as another set) whose smallest element is greater than the last element in *this.

Example​

Main.cpp
#include <set>
#include <cassert>
#include <iostream>
 
int main()
{
  std::set<int> set;
 
  auto result_1 = set.insert(3);
  assert(result_1.first != set.end()); // it's 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); // same iterator
  assert(*result_2.first == 3);
  if (!result_2.second)
    std::cout << "no insertion\n";
}
Possible output
insert done
no insertion
This article originates from this CppReference page. It was likely altered for improvements or editors' preference. Click "Edit this page" to see all changes made to this document.
Hover to see the original license.

std::set insert() method

// (1) Non const version only
std::pair<iterator, bool> insert( value_type&& value );

// (2) Non const version only
std::pair<iterator, bool> insert( value_type&& value );

// (3) Non const version only
iterator insert( const_iterator hint, const value_type& value );

// (4) Non const version only
iterator insert( const_iterator hint, value_type&& value );

// (5) Non const version only
template< class InputIt >
void insert( InputIt first, InputIt last );

// (6) Non const version only
void insert( std::initializer_list<value_type> ilist );

// (7) Non const version only
insert_return_type insert( node_type&& nh );

// (8) Non const version only
iterator insert( const_iterator hint, node_type&& nh );

Inserts element(s) into the container, if the container doesn't already contain an element with an equivalent key.

  • (1-2) Inserts value.

  • (3-4)

    Inserts value in the position as close as possible, just prior to hint.

  • (5) Inserts elements from range [ first; last ).

    If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).

  • (6) Inserts elements from initializer list ilist.

    If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted (pending LWG2844).

  • (7) If nh is an empty node handle, does nothing.

    Otherwise, inserts the element owned by nh into the container, if the container doesn't already contain an element with a key equivalent to nh.key().

Undefined behaviour

The behavior is undefined if nh is not empty and get_allocator() != nh.get_allocator().

  • (8) If nh is an empty node handle, does nothing and returns the end iterator.

    Otherwise, inserts the element owned by nh into the container, if the container doesn't already contain an element with a key equivalent to nh.key(), and returns the iterator pointing to the element with key equivalent to nh.key() (regardless of whether the insert succeeded or failed).

    If the insertion succeeds, nh is moved from, otherwise it retains ownership of the element. The element is inserted as close as possible to hint.

Undefined behaviour

The behavior is undefined if nh is not empty and get_allocator() != nh.get_allocator().

Invalidation

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.

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​

Return value​

  • (1-2) Returns a pair consisting of an iterator to the inserted element (or to the element that prevented the insertion) and a bool denoting whether the insertion took place (true if insertion happened, false if it did not).
  • (3-4) Returns an iterator to the inserted element, or to the element that prevented the insertion.
  • (5-6) (none)
  • (7) Returns an insert_return_type with the members initialized as follows:
    • If nh is empty, inserted is false, position is end(), and node is empty.
    • Otherwise if the insertion took place, inserted is true, position points to the inserted element, and node is empty.
    • If the insertion failed, inserted is false, node has the previous value of nh, and position points to an element with a key equivalent to nh.key().
  • (8) End iterator if nh was empty, iterator pointing to the inserted element if insertion took place, and iterator pointing to an element with a key equivalent to nh.key() if it failed.

Complexity​

  • (1-2) Logarithmic in the size of the container - O(log size()).

  • (3-4)

    Amortized constant if the insertion happens in the position just before the hint - O(1).
    Logarithmic in the size of the container otherwise - O(log size()).

  • (5-6) O(N * log(size() + N)), where N is the number of elements to insert.

  • (7) Logarithmic in the size of the container - O(log size()).

  • (8)
    Amortized constant if the insertion happens in the position just before hint - O(1), Logarithmic in the size of the container otherwise - O(log size()).

Exceptions​

  • (1-4) If an exception is thrown by any operation, the insertion has no effect.
important

This section requires improvement. You can help by editing this doc page.

Notes​

The hinted insert (3-4) 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.

The overloads (5-6) are often implemented as a loop that calls the overload (3) with end() as the hint; they are optimized for appending a sorted sequence (such as another set) whose smallest element is greater than the last element in *this.

Example​

Main.cpp
#include <set>
#include <cassert>
#include <iostream>
 
int main()
{
  std::set<int> set;
 
  auto result_1 = set.insert(3);
  assert(result_1.first != set.end()); // it's 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); // same iterator
  assert(*result_2.first == 3);
  if (!result_2.second)
    std::cout << "no insertion\n";
}
Possible output
insert done
no insertion
This article originates from this CppReference page. It was likely altered for improvements or editors' preference. Click "Edit this page" to see all changes made to this document.
Hover to see the original license.