summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-04-23 20:18:16 +0200
committerTyge Løvset <[email protected]>2021-04-23 20:18:16 +0200
commitb64b213895957de9eed31797295ccbd412ae8e71 (patch)
treeb8ca0c3c15c613816fbe3dc2f28f2bcdd63e05be /docs/cmap_api.md
parent7b85cf6e734fe312dd4b762282ff33010fe24bf3 (diff)
downloadSTC-modified-b64b213895957de9eed31797295ccbd412ae8e71.tar.gz
STC-modified-b64b213895957de9eed31797295ccbd412ae8e71.zip
API: Reverted to C_X_erase_at() instead of C_X_erase_it(). Sorry for the mess. Internal reorder of STC_API methods.
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 2f056479..78aecfa9 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -10,7 +10,7 @@ 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_it()*, which references the next element.
+through the container by using the returned iterator from *erase_at()*, which references the next element.
See the c++ class [std::unordered_map](https://en.cppreference.com/w/cpp/container/unordered_map) for a functional description.
@@ -75,7 +75,7 @@ cmap_X_result_t cmap_X_emplace_or_assign(cmap_X* self, RawKey rkey, RawMappe
void cmap_X_emplace_n(cmap_X* self, const cmap_X_rawvalue_t arr[], size_t n);
size_t cmap_X_erase(cmap_X* self, RawKey rkey); // return 0 or 1
-cmap_X_iter_t cmap_X_erase_it(cmap_X* self, cmap_X_iter_t it); // return iter after it
+cmap_X_iter_t cmap_X_erase_at(cmap_X* self, cmap_X_iter_t it); // return iter after it
void cmap_X_erase_entry(cmap_X* self, cmap_X_value_t* entry);
cmap_X_iter_t cmap_X_begin(const cmap_X* self);