From 3fe2c29204ee2ecc29ddc4a117109d5e3c92cb7a Mon Sep 17 00:00:00 2001 From: Christian Mazakas Date: Fri, 25 Feb 2022 13:59:00 -0800 Subject: [PATCH] Update documentation on `extract`/`insert` to no longer say that transferring nodes between the corresponding multi- container is not supported --- doc/unordered/unordered_map.adoc | 10 +++++----- doc/unordered/unordered_multimap.adoc | 10 +++++----- doc/unordered/unordered_multiset.adoc | 12 +++++++----- doc/unordered/unordered_set.adoc | 2 +- 4 files changed, 18 insertions(+), 16 deletions(-) diff --git a/doc/unordered/unordered_map.adoc b/doc/unordered/unordered_map.adoc index 053657d9..ebf53bf0 100644 --- a/doc/unordered/unordered_map.adoc +++ b/doc/unordered/unordered_map.adoc @@ -871,7 +871,7 @@ Removes the element pointed to by `position`. [horizontal] Returns:;; A `node_type` owning the element. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_multimap`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_multimap`. --- @@ -885,7 +885,7 @@ Removes an element with key equivalent to `k`. [horizontal] Returns:;; A `node_type` owning the element if found, otherwise an empty `node_type`. Throws:;; Only throws an exception if it is thrown by `hasher` or `key_equal`. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_multimap`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_multimap`. --- @@ -901,7 +901,7 @@ This overload only participates in overload resolution if `Hash::is_transparent` [horizontal] Returns:;; A `node_type` owning the element if found, otherwise an empty `node_type`. Throws:;; Only throws an exception if it is thrown by `hasher` or `key_equal`. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_multimap`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_multimap`. --- @@ -926,7 +926,7 @@ Notes:;; Can invalidate iterators, but only if the insert causes the load factor + Pointers and references to elements are never invalidated. + + -In C++17 this can be used to insert a node extracted from a compatible `unordered_multimap`, but that is not supported yet. +This can be used to insert a node extracted from a compatible `unordered_multimap`. --- @@ -957,7 +957,7 @@ Can invalidate iterators, but only if the insert causes the load factor to be gr + Pointers and references to elements are never invalidated. + + -In C++17 this can be used to insert a node extracted from a compatible `unordered_multimap`, but that is not supported yet. +This can be used to insert a node extracted from a compatible `unordered_multimap`. --- diff --git a/doc/unordered/unordered_multimap.adoc b/doc/unordered/unordered_multimap.adoc index d8eae540..b3b0928c 100644 --- a/doc/unordered/unordered_multimap.adoc +++ b/doc/unordered/unordered_multimap.adoc @@ -846,7 +846,7 @@ Removes the element pointed to by `position`. [horizontal] Returns:;; A `node_type` owning the element. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_map`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_map`. --- @@ -860,7 +860,7 @@ Removes an element with key equivalent to `k`. [horizontal] Returns:;; A `node_type` owning the element if found, otherwise an empty `node_type`. Throws:;; Only throws an exception if it is thrown by `hasher` or `key_equal`. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_map`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_map`. --- @@ -876,7 +876,7 @@ This overload only participates in overload resolution if `Hash::is_transparent` [horizontal] Returns:;; A `node_type` owning the element if found, otherwise an empty `node_type`. Throws:;; Only throws an exception if it is thrown by `hasher` or `key_equal`. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_map`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_map`. --- @@ -899,7 +899,7 @@ Notes:;; Can invalidate iterators, but only if the insert causes the load factor + Pointers and references to elements are never invalidated. + + -In C++17 this can be used to insert a node extracted from a compatible `unordered_map`, but that is not supported yet. +This can be used to insert a node extracted from a compatible `unordered_map`. --- @@ -926,7 +926,7 @@ Can invalidate iterators, but only if the insert causes the load factor to be gr + Pointers and references to elements are never invalidated. + + -In C++17 this can be used to insert a node extracted from a compatible `unordered_map`, but that is not supported yet. +This can be used to insert a node extracted from a compatible `unordered_map`. --- diff --git a/doc/unordered/unordered_multiset.adoc b/doc/unordered/unordered_multiset.adoc index 0369673e..f95357fd 100644 --- a/doc/unordered/unordered_multiset.adoc +++ b/doc/unordered/unordered_multiset.adoc @@ -806,7 +806,7 @@ Removes the element pointed to by `position`. [horizontal] Returns:;; A `node_type` owning the element. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_set`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_set`. --- @@ -820,7 +820,7 @@ Removes an element with key equivalent to `k`. [horizontal] Returns:;; A `node_type` owning the element if found, otherwise an empty `node_type`. Throws:;; Only throws an exception if it is thrown by `hasher` or `key_equal`. -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_set`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_set`. --- @@ -836,7 +836,7 @@ This overload only participates in overload resolution if `Hash::is_transparent` [horizontal] Returns:;; A `node_type` owning the element if found, otherwise an empty `node_type`. Throws:;; Only throws an exception if it is thrown by `hasher` or `key_equal`.[horizontal] -Notes:;; In C++17 a node extracted using this method can be inserted into a compatible `unordered_set`, but that is not supported yet. +Notes:;; A node extracted using this method can be inserted into a compatible `unordered_set`. --- @@ -857,7 +857,9 @@ Otherwise returns an iterator pointing to the newly inserted element. Throws:;; If an exception is thrown by an operation other than a call to `hasher` the function has no effect. Notes:;; Can invalidate iterators, but only if the insert causes the load factor to be greater to or equal to the maximum load factor. + + -Pointers and references to elements are never invalidated. In C++17 this can be used to insert a node extracted from a compatible `unordered_set`, but that is not supported yet. +Pointers and references to elements are never invalidated. + ++ +This can be used to insert a node extracted from a compatible `unordered_set`. --- @@ -884,7 +886,7 @@ Can invalidate iterators, but only if the insert causes the load factor to be gr + Pointers and references to elements are never invalidated. + + -In C++17 this can be used to insert a node extracted from a compatible `unordered_set`, but that is not supported yet. +This can be used to insert a node extracted from a compatible `unordered_set`. --- diff --git a/doc/unordered/unordered_set.adoc b/doc/unordered/unordered_set.adoc index 44670457..bc1d39e1 100644 --- a/doc/unordered/unordered_set.adoc +++ b/doc/unordered/unordered_set.adoc @@ -908,7 +908,7 @@ Can invalidate iterators, but only if the insert causes the load factor to be gr + Pointers and references to elements are never invalidated. + + -In C++17 this can be used to insert a node extracted from a compatible `unordered_multiset`, but that is not supported yet. +This can be used to insert a node extracted from a compatible `unordered_multiset`. ---