From e730c593429bdd5a73da5b02e7559b1f0fd21e19 Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Sat, 11 Feb 2023 23:55:24 +0100 Subject: Some more docs. Renamed (half-)internal template parameter i_size => i_ssize. Updated external cpp maps for benchmarks. --- docs/cset_api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/cset_api.md') diff --git a/docs/cset_api.md b/docs/cset_api.md index 27e633b4..34b6f3eb 100644 --- a/docs/cset_api.md +++ b/docs/cset_api.md @@ -21,7 +21,7 @@ A **cset** is an associative container that contains a set of unique objects of #define i_tag // alternative typename: cmap_{i_tag}. i_tag defaults to i_val #define i_hash_functor // advanced, see examples/functor.c for similar usage. #define i_eq_functor // advanced, see examples/functor.c for similar usage. -#define i_size // defines cset_X_sizet. default int32_t. If defined, table expand 2x (else 1.5x) +#define i_ssize // default int32_t. If defined, table expand 2x (else 1.5x) #include ``` `X` should be replaced by the value of `i_tag` in all of the following documentation. @@ -36,14 +36,14 @@ cset_X cset_X_clone(cset_x set); void cset_X_clear(cset_X* self); void cset_X_copy(cset_X* self, const cset_X* other); float cset_X_max_load_factor(const cset_X* self); // default: 0.85 -bool cset_X_reserve(cset_X* self, cset_X_sizet size); +bool cset_X_reserve(cset_X* self, i_ssize size); void cset_X_shrink_to_fit(cset_X* self); void cset_X_drop(cset_X* self); // destructor -cset_X_sizet cset_X_size(const cset_X* self); // num. of allocated buckets -cset_X_sizet cset_X_capacity(const cset_X* self); // buckets * max_load_factor +i_ssize cset_X_size(const cset_X* self); // num. of allocated buckets +i_ssize cset_X_capacity(const cset_X* self); // buckets * max_load_factor bool cset_X_empty(const cset_X* self); -cset_X_sizet cset_X_bucket_count(const cset_X* self); +i_ssize cset_X_bucket_count(const cset_X* self); 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 -- cgit v1.2.3