From ce1f74fb1bcad5491cce146d3198be8a507bdc4a Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Wed, 17 Mar 2021 12:28:34 +0100 Subject: Added csset_X_lower_bound() to docs, and some minor docs formatting. --- docs/cmap_api.md | 1 - docs/cset_api.md | 7 +++---- docs/csmap_api.md | 2 +- docs/csset_api.md | 7 ++++--- 4 files changed, 8 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/cmap_api.md b/docs/cmap_api.md index 593f78ab..a1db1a25 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -51,7 +51,6 @@ cmap_X cmap_X_clone(cmap_x map); void cmap_X_clear(cmap_X* self); void cmap_X_reserve(cmap_X* self, size_t size); 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); diff --git a/docs/cset_api.md b/docs/cset_api.md index db3321ae..ebca71ae 100644 --- a/docs/cset_api.md +++ b/docs/cset_api.md @@ -37,13 +37,12 @@ cset_X cset_X_clone(cset_x set); void cset_X_clear(cset_X* self); void cset_X_reserve(cset_X* self, size_t size); void cset_X_swap(cset_X* a, cset_X* b); - -void cset_X_del(cset_X* self); // destructor +void cset_X_del(cset_X* self); // destructor bool cset_X_empty(cset_X set); -size_t cset_X_size(cset_X set); +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_bucket_count(cset_X set); -size_t cset_X_capacity(cset_X set); cset_X_iter_t cset_X_find(const cset_X* self, RawKey rkey); bool cset_X_contains(const cset_X* self, RawKey rkey); diff --git a/docs/csmap_api.md b/docs/csmap_api.md index 4b8f058a..d6eb0ddc 100644 --- a/docs/csmap_api.md +++ b/docs/csmap_api.md @@ -49,7 +49,7 @@ csmap_X csmap_X_init(void); csmap_X csmap_X_clone(csmap_x map); void csmap_X_clear(csmap_X* self); void csmap_X_swap(csmap_X* a, csmap_X* b); -void csmap_X_del(csmap_X* self); // destructor +void csmap_X_del(csmap_X* self); // destructor bool csmap_X_empty(csmap_X map); size_t csmap_X_size(csmap_X map); diff --git a/docs/csset_api.md b/docs/csset_api.md index 4a39b864..21529f8c 100644 --- a/docs/csset_api.md +++ b/docs/csset_api.md @@ -34,12 +34,13 @@ csset_X csset_X_init(void); csset_X csset_X_clone(csset_x set); void csset_X_clear(csset_X* self); void csset_X_swap(csset_X* a, csset_X* b); -void csset_X_del(csset_X* self); // destructor +void csset_X_del(csset_X* self); // destructor -bool csset_X_empty(csset_X m); -size_t csset_X_size(csset_X m); +bool csset_X_empty(csset_X set); +size_t csset_X_size(csset_X set); csset_X_iter_t csset_X_find(const csset_X* self, RawKey rkey); +csset_X_iter_t csset_X_lower_bound(const csset_X* self, RawKey rkey); // find closest entry >= rkey csset_X_value_t* csset_X_find_it(const csset_X* self, RawKey rkey, csset_X_iter_t* out); bool csset_X_contains(const csset_X* self, RawKey rkey); -- cgit v1.2.3