std::unordered_set<Key,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 — единственный способ извлечь из множества объект, который можно только перемещать:

std::set<move_only_type> s;
s.emplace(...);
move_only_type mot = std::move(s.extract(s.begin()).value());

Макрос проверки возможностей	Значение	Стандарт	Возможность
`__cpp_lib_associative_heterogeneous_erasure`	`202110L`	(C++23)	Гетерогенное удаление в ассоциативных контейнерах и неупорядоченных ассоциативных контейнерах, (3)

Пример

#include <algorithm>
#include <iostream>
#include <string_view>
#include <unordered_set>

void print(std::string_view comment, const auto& data)
{
    std::cout << comment;
    for (auto datum : data)
        std::cout << ' ' << datum;

    std::cout << '\n';
}
 
int main()
{
    std::unordered_set<int> cont{1, 2, 3};

    print("Start:", cont);
    
    // Extract node handle and change key
    auto nh = cont.extract(1);
    nh.value() = 4;

    print("After extract and before insert:", cont);
 
    // Insert node handle back
    cont.insert(std::move(nh));

    print("End:", cont);
}

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

Start: 1 2 3
After extract and before insert: 2 3
End: 2 3 4

См. также

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_set/extract