summaryrefslogtreecommitdiffhomepage
path: root/docs/csmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-20 11:02:00 +0100
committerGitHub <[email protected]>2021-01-20 11:02:00 +0100
commitdcf7ba8a098251bf2af7c71d61f7d8af0662fd12 (patch)
tree5632f740df93c38e6738db2cf96dc3deccfbd44d /docs/csmap_api.md
parent616f51309113f41418166c030111914391670264 (diff)
downloadSTC-modified-dcf7ba8a098251bf2af7c71d61f7d8af0662fd12.tar.gz
STC-modified-dcf7ba8a098251bf2af7c71d61f7d8af0662fd12.zip
Update csmap_api.md
Diffstat (limited to 'docs/csmap_api.md')
-rw-r--r--docs/csmap_api.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 27fd22c6..6974d603 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -71,12 +71,12 @@ size_t csmap_X_size(csmap_X m);
void csmap_X_push_n(csmap_X* self, const csmap_X_rawvalue_t arr[], size_t size);
-csmap_X_result_t csmap_X_emplace(csmap_X* self, RawKey rkey, RawMapped rmapped);
-csmap_X_result_t csmap_X_insert(csmap_X* self, csmap_X_rawvalue_t rval);
+csmap_X_result_t csmap_X_emplace(csmap_X* self, RawKey rkey, RawMapped rmapped); // no change if rkey in map
+csmap_X_result_t csmap_X_insert(csmap_X* self, csmap_X_rawvalue_t rval); // same
csmap_X_result_t csmap_X_insert_or_assign(csmap_X* self, RawKey rkey, RawMapped rmapped);
-csmap_X_result_t csmap_X_put(csmap_X* self, RawKey rkey, RawMapped rmapped);
-csmap_X_result_t csmap_X_put_mapped(csmap_X* self, RawKey rkey, Mapped mapped);
-csmap_X_mapped_t* csmap_X_at(const csmap_X* self, RawKey rkey);
+csmap_X_result_t csmap_X_put(csmap_X* self, RawKey rkey, RawMapped rmapped); // same as insert_or_assign()
+csmap_X_result_t csmap_X_put_mapped(csmap_X* self, RawKey rkey, Mapped mapped); // same
+csmap_X_mapped_t* csmap_X_at(const csmap_X* self, RawKey rkey); // rkey must be in map.
size_t csmap_X_erase(csmap_X* self, RawKey rkey);
csmap_X_iter_t csmap_X_erase_at(csmap_X* self, csmap_X_iter_t pos);