std::map<Key,T,Compare,Allocator>::insert_or_assign (3) - Linux Manuals

std::map<Key,T,Compare,Allocator>::insert_or_assign: std::map<Key,T,Compare,Allocator>::insert_or_assign

NAME

std::map<Key,T,Compare,Allocator>::insert_or_assign - std::map<Key,T,Compare,Allocator>::insert_or_assign

Synopsis

template <class M> (1) (since C++17)
pair<iterator, bool> insert_or_assign(const key_type& k, M&& obj);
template <class M> (2) (since C++17)
pair<iterator, bool> insert_or_assign(key_type&& k, M&& obj);
template <class M> (3) (since C++17)
iterator insert_or_assign(const_iterator hint, const key_type& k, M&& obj);
template <class M> (4) (since C++17)
iterator insert_or_assign(const_iterator hint, key_type&& k, M&& obj);

1,3) If a key equivalent to k already exists in the container, assigns std::forward<M>(obj) to the mapped_type corresponding to the key k. If the key does not exist, inserts the new value as if by insert, constructing it from value_type(k, std::forward<M>(obj))
2,4) Same as (1,3), except the mapped value is constructed from value_type(std::move(k), std::forward<M>(obj))
No iterators or references are invalidated.

Parameters

k - the key used both to look up and to insert if not found
hint - iterator to the position before which the new element will be inserted
obj - the value to insert or assign

Return value

1,2) The bool component is true if the insertion took place and false if the assignment took place. The iterator component is pointing at the element that was inserted or updated
3,4) Iterator pointing at the element that was inserted or updated

Complexity

1,2) Same as for emplace
3,4) Same as for emplace_hint

Notes

insert_or_assign returns more information than operator[] and does not require default-constructibility of the mapped type.

Example

// Run this code

  #include <iostream>
  #include <map>
  #include <string>

  int main()
  {
      std::map<std::string, std::string> myMap;
      myMap.insert_or_assign("a", "apple" );
      myMap.insert_or_assign("b", "bannana" );
      myMap.insert_or_assign("c", "cherry" );
      myMap.insert_or_assign("c", "clementine");

      for (const auto &pair : myMap) {
          std::cout << pair.first << " : " << pair.second << '\n';
      }
  }

Output:

  a : apple
  b : bannana
  c : clementine