summaryrefslogtreecommitdiffhomepage
path: root/docs/cset_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-04-09 00:14:50 +0200
committerTyge Løvset <[email protected]>2022-04-09 00:14:50 +0200
commit1a4223837d4e34a085f00e323759ee5f9cd81bd3 (patch)
tree9be8cb543c9043fa885e511b86595c91ea1f4fc5 /docs/cset_api.md
parent03065ed6ef93f88003cd6754ca4d50ba20a76ebd (diff)
downloadSTC-modified-1a4223837d4e34a085f00e323759ee5f9cd81bd3.tar.gz
STC-modified-1a4223837d4e34a085f00e323759ee5f9cd81bd3.zip
Universally added a put() function to all containers.
Diffstat (limited to 'docs/cset_api.md')
-rw-r--r--docs/cset_api.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/cset_api.md b/docs/cset_api.md
index b5f8073b..56c2669c 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -29,27 +29,28 @@ cset_X cset_X_clone(cset_x set);
void cset_X_clear(cset_X* self);
void cset_X_copy(cset_X* self, cset_X other);
-void cset_X_max_load_factor(cset_X* self, float max_load); // default: 0.85
+void cset_X_max_load_factor(cset_X* self, float max_load); // default: 0.85
bool cset_X_reserve(cset_X* self, size_t size);
void cset_X_shrink_to_fit(cset_X* self);
void cset_X_swap(cset_X* a, cset_X* b);
-void cset_X_drop(cset_X* self); // destructor
+void cset_X_drop(cset_X* self); // destructor
-size_t cset_X_size(cset_X set); // num. of allocated buckets
-size_t cset_X_capacity(cset_X set); // buckets * max_load_factor
+size_t cset_X_size(cset_X set); // num. of allocated buckets
+size_t cset_X_capacity(cset_X set); // buckets * max_load_factor
bool cset_X_empty(cset_X set);
size_t cset_X_bucket_count(cset_X set);
bool cset_X_contains(const cset_X* self, i_keyraw rkey);
-const cset_X_value* cset_X_get(const cset_X* self, i_keyraw rkey); // return NULL if not found
-cset_X_value* cset_X_get_mut(cset_X* self, i_keyraw rkey); // mutable get
+const cset_X_value* cset_X_get(const cset_X* self, i_keyraw rkey); // return NULL if not found
+cset_X_value* cset_X_get_mut(cset_X* self, i_keyraw rkey); // mutable get
cset_X_iter cset_X_find(const cset_X* self, i_keyraw rkey);
cset_X_result cset_X_insert(cset_X* self, i_key key);
+cset_X_result cset_X_put(cset_X* self, i_key key); // alias for insert()
cset_X_result cset_X_emplace(cset_X* self, i_keyraw rkey);
-size_t cset_X_erase(cset_X* self, i_keyraw rkey); // return 0 or 1
-cset_X_iter cset_X_erase_at(cset_X* self, cset_X_iter it); // return iter after it
+size_t cset_X_erase(cset_X* self, i_keyraw rkey); // return 0 or 1
+cset_X_iter cset_X_erase_at(cset_X* self, cset_X_iter it); // return iter after it
void cset_X_erase_entry(cset_X* self, cset_X_value* entry);
cset_X_iter cset_X_begin(const cset_X* self);