std::multiset<Key,Compare,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). Этот перегруз участвует в разрешении перегрузки только в том случае, если квалифицированный идентификатор Compare::is_transparent является допустимым и обозначает тип, и ни iterator, ни const_iterator не неявно преобразуются из K. Это позволяет вызывать эту функцию без создания экземпляра Key.

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

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

Параметры

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

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

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

Исключения

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

2,3) Любые исключения, сгенерированные объектом Compare.

Сложность

1) Амортизированная константа.

2,3) log(size())

Примечания

extract — единственный способ извлечь перемещаемый объект из множества:

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

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

Пример

#include <algorithm>
#include <iostream>
#include <string_view>
#include <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::multiset<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	вставляет элементы или узлы(since C++17) (общедоступный член-функция)
erase	удаляет элементы (общедоступный член-функция)

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