23 Containers library [containers]

23.2 Requirements [container.requirements]

23.2.5 Node handles [container.node]

23.2.5.1 Overview [container.node.overview]

A node handle is an object that accepts ownership of a single element from an associative container ([associative.reqmts]) or an unordered associative container ([unord.req]).

It may be used to transfer that ownership to another container with compatible nodes.

Containers with compatible nodes have the same node handle type.

Elements may be transferred in either direction between container types in the same row of Table 73 .

Table 73 — Container types with compatible nodes [tab:container.node.compat]

🔗 map<K, T, C1, A>	map<K, T, C2, A>
🔗 map<K, T, C1, A>	multimap<K, T, C2, A>
🔗 set<K, C1, A>	set<K, C2, A>
🔗 set<K, C1, A>	multiset<K, C2, A>
🔗 unordered_map<K, T, H1, E1, A>	unordered_map<K, T, H2, E2, A>
🔗 unordered_map<K, T, H1, E1, A>	unordered_multimap<K, T, H2, E2, A>
🔗 unordered_set<K, H1, E1, A>	unordered_set<K, H2, E2, A>
🔗 unordered_set<K, H1, E1, A>	unordered_multiset<K, H2, E2, A>

If a node handle is not empty, then it contains an allocator that is equal to the allocator of the container when the element was extracted.

If a node handle is empty, it contains no allocator.

Class node-handle is for exposition only.

If a user-defined specialization of pair exists for pair<const Key, T> or pair<Key, T>, where Key is the container's key_type and T is the container's mapped_type, the behavior of operations involving node handles is undefined.

template<unspecified> class node-handle { public: // These type declarations are described in [associative.reqmts] and [unord.req]. using value_type = see below; // not present for map containers using key_type = see below; // not present for set containers using mapped_type = see below; // not present for set containers using allocator_type = see below; private: using container_node_type = unspecified; // exposition only using ator_traits = allocator_traits<allocator_type>; // exposition only typename ator_traits::template rebind_traits<container_node_type>::pointer ptr_; // exposition only optional<allocator_type> alloc_; // exposition only public: // [container.node.cons], constructors, copy, and assignment constexpr node-handle() noexcept : ptr_(), alloc_() {} constexpr node-handle(node-handle&&) noexcept; constexpr node-handle& operator=(node-handle&&); // [container.node.dtor], destructor constexpr ~node-handle(); // [container.node.observers], observers constexpr value_type& value() const; // not present for map containers key_type& key() const; // not present for set containers constexpr mapped_type& mapped() const; // not present for set containers constexpr allocator_type get_allocator() const; constexpr explicit operator bool() const noexcept; constexpr bool empty() const noexcept; // [container.node.modifiers], modifiers constexpr void swap(node-handle&) noexcept(ator_traits::propagate_on_container_swap::value || ator_traits::is_always_equal::value); constexpr friend void swap(node-handle& x, node-handle& y) noexcept(noexcept(x.swap(y))) { x.swap(y); } };

23.2.5.2 Constructors, copy, and assignment [container.node.cons]

🔗

constexpr node-handle(node-handle&& nh) noexcept;

Effects: Constructs a node-handle object initializing ptr_ with nh.ptr_.

Move constructs alloc_ with nh.alloc_.

Assigns nullptr to nh.ptr_ and assigns nullopt to nh.alloc_.

🔗

constexpr node-handle& operator=(node-handle&& nh);

Preconditions: Either !alloc_, or ator_traits::propagate_on_container_move_assignment::value is true, or alloc_ == nh.alloc_.

Effects:

(3.1)
If ptr_ != nullptr, destroys the value_type subobject in the container_node_type object pointed to by ptr_ by calling ator_traits::destroy, then deallocates ptr_ by calling ator_traits::template rebind_traits<container_node_type>::deallocate.
(3.2)
Assigns nh.ptr_ to ptr_.
(3.3)
If !alloc_ or ator_traits::propagate_on_container_move_assignment::value is true, move assigns nh.alloc_ to alloc_.
(3.4)
Assigns nullptr to nh.ptr_ and assigns nullopt to nh.alloc_.

Returns: *this.

Throws: Nothing.

23.2.5.3 Destructor [container.node.dtor]

🔗

constexpr ~node-handle();

Effects: If ptr_ != nullptr, destroys the value_type subobject in the container_node_type object pointed to by ptr_ by calling ator_traits::destroy, then deallocates ptr_ by calling ator_traits::template rebind_traits<container_node_type>::deallocate.

23.2.5.4 Observers [container.node.observers]

🔗

constexpr value_type& value() const;

Preconditions: empty() == false.

Returns: A reference to the value_type subobject in the container_node_type object pointed to by ptr_.

Throws: Nothing.

🔗

key_type& key() const;

Preconditions: empty() == false.

Returns: A non-const reference to the key_type member of the value_type subobject in the container_node_type object pointed to by ptr_.

Throws: Nothing.

Remarks: Modifying the key through the returned reference is permitted.

🔗

constexpr mapped_type& mapped() const;

Preconditions: empty() == false.

Returns: A reference to the mapped_type member of the value_type subobject in the container_node_type object pointed to by ptr_.

Throws: Nothing.

🔗

constexpr allocator_type get_allocator() const;

Preconditions: empty() == false.

Returns: *alloc_.

Throws: Nothing.

🔗

constexpr explicit operator bool() const noexcept;

Returns: ptr_ != nullptr.

🔗

constexpr bool empty() const noexcept;

Returns: ptr_ == nullptr.

23.2.5.5 Modifiers [container.node.modifiers]

🔗

constexpr void swap(node-handle& nh)
  noexcept(ator_traits::propagate_on_container_swap::value ||
           ator_traits::is_always_equal::value);

Preconditions: !alloc_, or !nh.alloc_, or ator_traits::propagate_on_container_swap::value is true, or alloc_ == nh.alloc_.

Effects: Calls swap(ptr_, nh.ptr_).

If !alloc_, or !nh.alloc_, or ator_traits::propagate_on_container_swap::value is true calls swap(alloc_, nh.alloc_).