summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-11-03 11:30:06 +0100
committerTyge Løvset <[email protected]>2021-11-03 11:30:06 +0100
commite259ed7807dd9474cc94ba625db4dcd573431362 (patch)
tree0e83bf2d49a1f0ec43f9e9b0b74c69ef4fd97a1b /docs/cmap_api.md
parent73b1ed7c17b94647438c7e73738bf0820e5d57ad (diff)
downloadSTC-modified-e259ed7807dd9474cc94ba625db4dcd573431362.tar.gz
STC-modified-e259ed7807dd9474cc94ba625db4dcd573431362.zip
Changed container_X_get() and container_X_at() to return const value* (or const mapped*). Added container_X_getmut() for mutable version. Updated docs.
Diffstat (limited to 'docs/cmap_api.md')
-rw-r--r--docs/cmap_api.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 9bdafcb9..0e677880 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -49,15 +49,16 @@ void cmap_X_shrink_to_fit(cmap_X* self);
void cmap_X_swap(cmap_X* a, cmap_X* b);
void cmap_X_del(cmap_X* self); // destructor
-bool cmap_X_empty(cmap_X map);
size_t cmap_X_size(cmap_X map);
size_t cmap_X_capacity(cmap_X map); // buckets * max_load_factor
+bool cmap_X_empty(cmap_X map);
size_t cmap_X_bucket_count(cmap_X map); // num. of allocated buckets
-bool cmap_X_contains(const cmap_X* self, i_keyraw rkey);
-cmap_X_mapped* cmap_X_at(const cmap_X* self, i_keyraw rkey); // rkey must be in map.
-cmap_X_value* cmap_X_get(const cmap_X* self, i_keyraw rkey); // return NULL if not found
-cmap_X_iter cmap_X_find(const cmap_X* self, i_keyraw rkey);
+const cmap_X_mapped* cmap_X_at(const cmap_X* self, i_keyraw rkey); // rkey must be in map.
+const cmap_X_value* cmap_X_get(const cmap_X* self, i_keyraw rkey); // const get
+cmap_X_value* cmap_X_mutget(cmap_X* self, i_keyraw rkey); // mutable get
+bool cmap_X_contains(const cmap_X* self, i_keyraw rkey);
+cmap_X_iter cmap_X_find(const cmap_X* self, i_keyraw rkey); // find element
cmap_X_result cmap_X_insert(cmap_X* self, i_key key, i_val mapped); // no change if key in map
cmap_X_result cmap_X_insert_or_assign(cmap_X* self, i_key key, i_val mapped); // always update mapped