节点句柄 (C++17)
template</* 未指定 */> class /*node-handle*/; |
(C++17 起) (仅作说明*) |
|
关联容器 std::set, std::map, std::multiset, std::multimap, std::unordered_set, std::unordered_map, std::unordered_multiset, std::unordered_multimap 是基于节点的D数据结构，它们的节点可以作为一种未指定类型的对象提取，这种对象被称为 *节点句柄*。
节点句柄是一种仅可移动的类型，它拥有并提供对节点中存储的元素（value_type）的访问，并提供对元素的键部分（key_type）和映射部分（mapped_type）的非 const 访问。如果节点句柄在持有节点时被销毁，则会使用容器的相应分配器正确销毁节点。节点句柄包含容器分配器的副本。这是必要的，以便节点句柄可以比容器寿命更长。
节点句柄的确切类型（此处显示为 /*node-handle*/）未指定，但每个容器都将其节点句柄类型公开为成员 node_type。
节点句柄可用于在两个关联容器之间传输元素的拥有权，这两个容器具有相同的键、值和分配器类型（忽略比较或哈希/相等），而无需对容器元素调用任何复制/移动操作（这种操作被称为“拼接”）。也允许在唯一和非唯一容器之间进行传输：来自 std::map 的节点句柄可以插入到 std::multimap 中，但不能插入到 std::unordered_map 或 std::set 中。
节点句柄可以为空，在这种情况下，它不持有任何元素或分配器。默认构造和移动构造的节点句柄为空。此外，通过调用容器成员函数 extract 失败也可以生成空节点句柄。
如果元素成功插入到容器中，则在节点句柄拥有元素时获得的指向元素的指针和引用将失效。
对于所有 map 容器（std::map、std::multimap、std::unordered_map 和 std::unordered_multimap），如果其 key_type 为 K 且 mapped_type 为 T，并且存在 std::pair<K, T> 或 std::pair<const K, T> 的用户定义特化，则涉及节点句柄的操作行为未定义。
目录 |
[编辑] 成员类型
| 类型 | 定义 |
key_type (仅限 map 容器) |
存储在节点中的键 |
mapped_type (仅限 map 容器) |
存储在节点中的元素的映射部分 |
value_type (仅限 set 容器) |
存储在节点中的元素 |
allocator_type
|
销毁元素时要使用的分配器 |
container_node_type (私有) |
容器节点，类型未指定 (仅供说明的成员类型*) |
ator_traits (私有) |
类型为 std::allocator_traits<allocator_type> 的分配器特性 (仅供说明的成员类型*) |
[编辑] 数据成员
| 成员 | 定义 |
| typename ator_traits::template rebind_traits<container_node_type>::pointer ptr_(有条件存在) |
待办 (仅用于阐释的成员对象*) |
std::optional<allocator_type> alloc_(有条件存在) |
待办 (仅用于阐释的成员对象*) |
[编辑] 成员函数
构造函数
| constexpr /*node-handle*/() noexcept; |
(1) | |
| /*node-handle*/(/*node-handle*/&& nh) noexcept; |
(2) | |
参数
| nh | - | 具有相同类型（不一定是相同容器）的节点句柄 |
注意
节点句柄是仅可移动的，未定义复制构造函数。
operator=
| /*node-handle*/& operator=(/*node-handle*/&& nh); |
||
- 如果节点句柄不为空，则
- 通过调用
ator_traits::destroy销毁此节点句柄管理的容器元素对象中的value_type子对象； - 通过调用 ator_traits::rebind_traits</*container-node-type*/>::deallocate 解分配容器元素；
- 通过调用
- 从 nh 获得容器元素的拥有权；
- 如果节点句柄为空（因此不包含分配器）或如果 ator_traits::propagate_on_container_move_assignment 为 true，则从 nh 移动赋值分配器；
- 将 nh 设置为空状态。
如果节点不为空且 ator_traits::propagate_on_container_move_assignment 为 false 并且分配器不相等，则行为未定义。
参数
| nh | - | 具有相同类型（不一定是相同容器）的节点句柄 |
返回
*this
异常
不抛出任何异常。
注意
节点句柄是仅可移动的，未定义复制赋值。
析构函数
| ~/*node-handle*/(); |
||
- 如果节点句柄不为空，则
- 通过调用 ator_traits::destroy 销毁此节点句柄管理的容器元素对象中的
value_type子对象； - 通过调用 ator_traits::rebind_traits</*container-node-type*/>::deallocate 解分配容器元素。
- 通过调用 ator_traits::destroy 销毁此节点句柄管理的容器元素对象中的
empty
| bool empty() const noexcept; |
||
如果节点句柄为空，则返回 true，否则返回 false。
operator bool
| explicit operator bool() const noexcept; |
||
如果节点句柄为空，则转换为 false，否则转换为 true。
get_allocator
| allocator_type get_allocator() const; |
||
返回存储的分配器（源容器分配器的副本）。如果节点句柄为空，则行为未定义。
异常
不抛出任何异常。
value
| value_type& value() const; |
(仅限 set 容器) | |
返回对此节点句柄管理的容器元素对象中的 value_type 子对象的引用。如果节点句柄为空，则行为未定义。
异常
不抛出任何异常。
key
| key_type& key() const; |
(仅限 map 容器) | |
返回对此节点句柄管理的容器元素对象中的 value_type 子对象的 key_type 成员的非 const 引用。如果节点句柄为空，则行为未定义。
异常
不抛出任何异常。
注意
此函数使得修改从 map 中提取的节点的键成为可能，然后将其重新插入到 map 中，而无需复制或移动元素。
mapped
| mapped_type& mapped() const; |
(仅限 map 容器) | |
返回对此节点句柄管理的容器元素对象中的 value_type 子对象的 mapped_type 成员的引用。如果节点句柄为空，则行为未定义。
异常
不抛出任何异常。
swap
| void swap(/*node-handle*/& nh) noexcept(/* 见下文 */); |
||
- 交换容器节点的拥有权；
- 如果一个节点为空或者两个节点都不为空且 ator_traits::propagate_on_container_swap 为 true，则也交换分配器。
如果两个节点都不为空且 ator_traits::propagate_on_container_swap 为 false 并且分配器不相等，则行为未定义。
异常
ator_traits::is_always_equal::value)
