std::unordered_multimap<Key,T,Hash,KeyEqual,Allocator>::extract

node_type extract( const_iterator position );	(1)	(since C++17)
node_type extract( const Key& k );	(2)	(since C++17)
template< class K > node_type extract( K&& x );	(3)	(since C++23)

1) Отсоединяет узел, содержащий элемент, на который указывает position, и возвращает обработчик узла, который его владеет.

2) Если в контейнере есть элемент с ключом, эквивалентным k, отсоединяет узел, содержащий первый такой элемент из контейнера, и возвращает обработчик узла, который его владеет. В противном случае возвращает пустой обработчик узла.

3) То же, что (2). Этот перегруз участвует в разрешении перегрузки только если Hash::is_transparent и KeyEqual::is_transparent являются допустимыми и каждый обозначает тип, и ни iterator ни const_iterator не неявно преобразуется из K. Предполагается, что такой Hash вызываем как с типом K, так и с типом Key, и что KeyEqual является прозрачным, что вместе позволяет вызвать эту функцию без создания экземпляра Key.

В любом случае, элементы не копируются и не перемещаются, только внутренние указатели узлов контейнера перенаправляются.

Извлечение узла делает недействительными только итераторы на извлеченный элемент и сохраняет относительный порядок элементов, которые не были удалены. Указатели и ссылки на извлеченный элемент остаются действительными, но не могут быть использованы, пока элемент принадлежит обработчику узла: они становятся применимы, если элемент вставляется в контейнер.

Параметры

position	-	допустимый итератор в этом контейнере
k	-	ключ для идентификации узла, который будет извлечен
x	-	значение любого типа, который может быть прозрачно сравнен с ключом, идентифицирующим узел, который будет извлечен

Возвращаемое значение

Обработчик узла, который владеет извлеченным элементом, или пустой обработчик узла в случае, если элемент не найден в (2,3).

Исключения

1) Ничего не выбрасывает.

2,3) Любые исключения, выброшенные объектом Hash и KeyEqual.

Сложность

1,2,3) Средний случай O(1), худший случай O(size()).

Примечания

extract — единственный способ изменить ключ элемента карты без перераспределения:

std::map<int, std::string> m{{1, "mango"}, {2, "papaya"}, {3, "guava"}};
auto nh = m.extract(2);
nh.key() = 4;
m.insert(std::move(nh));
// m == {{1, "mango"}, {3, "guava"}, {4, "papaya"}}

Макросы проверки наличия функции	Значение	Std	Функция
`__cpp_lib_associative_heterogeneous_erasure`	202110L	(C++23)	Гетерогенное удаление в ассоциативных контейнерах и неупорядоченных ассоциативных контейнерах, (3)

Пример

#include <algorithm>
#include <iostream>
#include <string_view>
#include <unordered_map>
 
void print(std::string_view comment, const auto& data)
{
    std::cout << comment;
    for (auto [k, v] : data)
        std::cout << ' ' << k << '(' << v << ')';
 
    std::cout << '\n';
}
 
int main()
{
    std::unordered_multimap<int, char> cont{{1, 'a'}, {2, 'b'}, {3, 'c'}};
 
    print("Start:", cont);
 
    // Extract node handle and change key
    auto nh = cont.extract(1);
    nh.key() = 4;
 
    print("After extract and before insert:", cont);
 
    // Insert node handle back
    cont.insert(std::move(nh));
 
    print("End:", cont);
}

Возможный вывод:

Start: 1(a) 2(b) 3(c)
After extract and before insert: 2(b) 3(c)
End: 2(b) 3(c) 4(a)

См. также

merge (C++17)	Объединяет узлы из другого контейнера (общедоступная функция-член)
insert	Вставляет элементы или узлы(since C++17) (общедоступная функция-член)
erase	Удаляет элементы (общедоступная функция-член)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/container/unordered_multimap/extract