Merge pull request #108 from cmazakas/insert-doc-fixes

`insert()`/`extract()` doc fixes + test improvements
This commit is contained in:
Peter Dimov
2022-02-26 04:01:30 +02:00
committed by GitHub
5 changed files with 150 additions and 22 deletions
+5 -5
View File
@@ -850,7 +850,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`.
---
@@ -864,7 +864,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`.
---
@@ -880,7 +880,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`.
---
@@ -903,7 +903,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`.
---
@@ -930,7 +930,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`.
---