std::unordered_set<Key,Hash,KeyEqual,Allocator>::insert

来自cppreference.com
 
C++
 
容器库
 
std::unordered_set
成员类型
成员函数
迭代器
容量
修改器
查找
桶接口
散列策略
观察器
非成员函数
(C++11)(C++11)(C++20 前)
推导指引(C++17)
 
std::pair<iterator,bool> insert( const value_type& value );
 (1) (C++11 起)
std::pair<iterator,bool> insert( value_type&& value );
 (2) (C++11 起)
iterator insert( const_iterator hint, const value_type& value );
 (3) (C++11 起)
iterator insert( const_iterator hint, value_type&& value );
 (4) (C++11 起)
template< class InputIt >
void insert( InputIt first, InputIt last );
 (5) (C++11 起)
void insert( std::initializer_list<value_type> ilist );
 (6) (C++11 起)
insert_return_type insert( node_type&& nh );
 (7) (C++17 起)
iterator insert( const_iterator hint, node_type&& nh );
 (8) (C++17 起)
template< class K >
std::pair<iterator, bool> insert( K&& obj );
 (9) (C++23 起)
template< class K >
iterator insert( const_iterator hint, K&& obj );
 (10) (C++23 起)

若容器尚未含有等价的键的元素，则插入元素到容器中。

1,2) 插入 value。
3,4) 插入 value，以 hint 为应当开始搜索的位置的非强制建议。
5) 插入来自范围 [first, last) 的元素。如果范围中的多个元素的键比较相等，那么未指定哪个元素会被插入（参考待决的 LWG2844）。
6) 插入来自 initializer_list ilist 的元素。如果范围中的多个元素的键比较相等，那么未指定哪个元素会被插入（参考待决的 LWG2844）。
7) 如果 nh 是空的节点句柄，那么什么都不做。否则插入 nh 所拥有的元素到容器，如果容器尚未含有拥有等价于 nh.key() 的键的元素。如果 nh 非空且 get_allocator() != nh.get_allocator()，那么行为未定义。
8) 如果 nh 是空的节点句柄，那么什么都不做并返回尾迭代器。否则，插入 nh 所拥有的元素到容器，如果容器尚未含有拥有等价于 nh.key() 的键的元素，并返回指向拥有等于 nh.key() 的键的元素的迭代器（无关乎插入成功还是失败）。如果插入成功，那么从 nh 移动，否则它保持该元素的所有权。以 hint 作为应当开始搜索的位置的非强制建议。如果 nh 非空且 get_allocator() != nh.get_allocator()，那么行为未定义。
9) 如果 *this 已经包含了与 obj 透明比较相等的元素，则不做任何事。否则，以 std::forward<K>(obj) 构造一个 value_type 类型的对象 u，然后将 u 插入 *this 中。如果 equal_range(u) != equal_range(obj) 为 true，则其行为未定义。value_type 必须为以 std::forward<K>(obj) 向 unordered_set 中可就位构造 (EmplaceConstructible) 。此重载只有在Hash::is_transparent 与 KeyEqual::is_transparent 均合法并指代类型时才会参与重载决议。这假设使得 Hash 能用 K 和 Key 类型调用，并且 KeyEqual 是透明的，进而允许调用此函数时不需要构造 Key 的实例。
10) 如果 *this 已经包含了与 obj 透明比较相等的元素，则不做任何事。

否则，以 std::forward<K>(obj) 构造一个 value_type 类型的对象 u，然后将 u 插入 *this 中，以 hint 为从何处开始搜索的非强制建议。如果 equal_range(u) != equal_range(obj) 为 true，则其行为未定义。 value_type 必须为以 std::forward<K>(obj) 向 unordered_set 中可就位构造 (EmplaceConstructible) 。仅当符合以下条件时，此重载才参与重载决议：

  • std::is_convertible_v<K&&, const_iterator> 和 std::is_convertible_v<K&&, iterator> 均为 false，并且
  • Hash::is_transparent 和 KeyEqual::is_transparent 均合法且各自代表某个类型。其中假定这个 Hash 对于类型 K 和 Key 均可调用，且 KeyEqual 是透明的。
这些条件共同允许不构造 Key 就能调用此函数。

如果操作后新的元素数量大于原 max_load_factor() * bucket_count() 则会发生重散列。
如果（因插入而）发生了重散列，索引迭代器均会失效。否则（未发生重散列），则迭代器不会失效。 如果插入成功，在元素被节点句柄持有时所获取的指向元素的指针或引用均会失效，而在元素被提取之前所获取的指向它指针和引用则变为有效。 (C++17 起)

参数

hint - 迭代器，用作插入内容位置的建议
value - 要插入的元素值
first, last - 要插入的元素范围
ilist - 插入值来源的 initializer_list
nh - 兼容的结点句柄
obj - 可以与键进行透明比较的任意类型的值
类型要求
-
InputIt 必须满足老式输入迭代器 (LegacyInputIterator) 。

返回值

1,2) 由一个指向被插入元素（或指向妨碍插入的元素）的迭代器和一个当且仅当发生插入时被设为 true 的 bool 值构成的对偶。
3,4) 指向被插入元素或指向妨碍插入的元素的迭代器。
5,6) （无）
7) insert_return_type 类型的对象，它的成员初始化如下：
  • 如果 nh 为空，那么 inserted 是 false，position 是 end()，且 node 为空。
  • 否则如果发生插入，那么 inserted 是 true，position 指向被插入元素，且 node 为空。
  • 如果插入失败，那么 inserted 是 false，node 拥有 nh 的先前值，且 position 指向拥有等价于 nh.key() 的键的元素。
8) 如果 nh 为空就是尾迭代器，如果插入发生就是指向被插入元素的迭代器，而如果插入失败就是指向拥有等价于 nh.key() 的键的元素的迭代器。
9) 由一个指向被插入元素（或指向妨碍插入的元素）的迭代器和一个当且仅当发生插入时被设为 true 的 bool 值构成的对偶。
10) 指向被插入元素或指向妨碍插入的元素的迭代器。

异常

1-4) 若任何操作抛出异常，则插入无效果。
本节未完成
原因：情况 5-10

复杂度

1-4) 平均情况：O(1)，最坏情况 O(size())。
5,6) 平均情况：O(N)，其中 N 是要插入的元素数。最坏情况： O(N*size()+N)。
7-10) 平均情况：O(1)，最坏情况 O(size())。

注解

有提示插入 (3,4) 不返回布尔值，这是为了与顺序容器上的定位插入，如 std::vector::insert 签名兼容。这使得可以创建泛型插入器，例如 std::inserter。检查有提示插入是否成功的一种方式是比较插入前后的 size()。

功能特性测试宏 值 标准 功能特性
__cpp_lib_associative_heterogeneous_insertion 202311L (C++26) 有序和无序关联容器中剩余成员函数的异质重载。(9,10)

示例

运行此代码
#include <array>
#include <iostream>
#include <unordered_set>
 
std::ostream& operator<<(std::ostream& os, std::unordered_set<int> const& s)
{
    for (os << '[' << s.size() << "] { "; int i : s)
        os << i << ' ';
    return os << "}\n";
}
 
int main ()
{
    std::unordered_set<int> nums{2, 3, 4};
 
    std::cout << "1) 起初: " << nums << std::boolalpha;
    auto p = nums.insert(1); // 插入元素, 重载 (1)
    std::cout << "2) '1' 已被插入: " << p.second << '\n';
    std::cout << "3) 插入后: " << nums;
 
    nums.insert(p.first, 0); // 按提示插入, 重载 (3)
    std::cout << "4) 插入后: " << nums;
 
    std::array<int, 4> a = {10, 11, 12, 13};
    nums.insert(a.begin(), a.end()); // 插入范围, 重载 (5)
    std::cout << "5) 插入后: " << nums;
 
    nums.insert({20, 21, 22, 23}); // 插入 initializer_list, (6)
    std::cout << "6) 插入后: " << nums;
 
    std::unordered_set<int> other_nums = {42, 43};
    auto node = other_nums.extract(other_nums.find(42));
    nums.insert(std::move(node)); // 插入节点, 重载 (7)
    std::cout << "7) 插入后: " << nums;
 
    node = other_nums.extract(other_nums.find(43));
    nums.insert(nums.begin(), std::move(node)); // 按提示插入节点, (8)
    std::cout << "8) 插入后: " << nums;
}

可能的输出： 

1) 起初: [3] { 4 3 2 }
2) '1' 已被插入: true
3) 插入后: [4] { 1 2 3 4 }
4) 插入后: [5] { 0 1 2 3 4 }
5) 插入后: [9] { 13 12 11 10 4 3 2 1 0 }
6) 插入后: [13] { 23 22 13 12 11 10 21 4 20 3 2 1 0 }
7) 插入后: [14] { 42 23 22 13 12 11 10 21 4 20 3 2 1 0 }
8) 插入后: [15] { 43 42 23 22 13 12 11 10 21 4 20 3 2 1 0 }

参阅

 原位构造元素
(公开成员函数)
使用提示原位构造元素
(公开成员函数)
创建拥有从实参推出的类型的 std::insert_iterator
(函数模板)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/container/unordered_set/insert&oldid=88997”