summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2023-04-27 12:41:24 +0200
committerTyge Løvset <[email protected]>2023-04-27 12:41:24 +0200
commitba3f2284731e50100d249cf1d825b8d24efad658 (patch)
tree888fd07f8dac722c913cb3bd7358dd20dafce70c /docs/cmap_api.md
parent9d5766ae528595050dcfe0db4c1c3c0c058b186c (diff)
downloadSTC-modified-ba3f2284731e50100d249cf1d825b8d24efad658.tar.gz
STC-modified-ba3f2284731e50100d249cf1d825b8d24efad658.zip
removing compiler warning ++.
Diffstat (limited to 'docs/cmap_api.md')
-rw-r--r--docs/cmap_api.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 94f1c54e..cdb57534 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -9,8 +9,8 @@ hashing (aka open addressing) with linear probing, and without leaving tombstone
***Iterator invalidation***: References and iterators are invalidated after erase. No iterators are invalidated after insert,
unless the hash-table need to be extended. The hash table size can be reserved prior to inserts if the total max size is known.
-The order of elements is preserved after erase and insert. This makes it possible to erase individual elements while iterating
-through the container by using the returned iterator from *erase_at()*, which references the next element.
+The order of elements may not be preserved after erase. It is still possible to erase elements when iterating through
+the container by setting the iterator to the value returned from *erase_at()*, which references the next element. Note that a small number of elements may be visited twice when doing this, but all elements will be visited.
See the c++ class [std::unordered_map](https://en.cppreference.com/w/cpp/container/unordered_map) for a functional description.