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

node_type extract( const_iterator position );	(1)	(начиная с C++17)
node_type extract( const Key& k );	(2)	(начиная с C++17)
template< class K > node_type extract( K&& x );	(3)	(начиная с 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 — единственный способ изменить ключ элемента map без перераспределения памяти:

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"}}

Макрос проверки возможностей	Значение	Стандарт	Возможность
`__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	вставляет элементы или узлы(начиная с C++17) (открытая функция-член)
erase	удаляет элементы (открытая функция-член)

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