summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Lovset <[email protected]>2022-07-11 23:53:06 +0200
committerTyge Lovset <[email protected]>2022-07-11 23:53:06 +0200
commit839efba934c8623f2dea31e7f8bb2857624c6908 (patch)
tree218e165ae2b65f6c2be41ea8169fb71432b4e68e /docs
parent5082397444550d9486783fe498629524a64d564e (diff)
downloadSTC-modified-839efba934c8623f2dea31e7f8bb2857624c6908.tar.gz
STC-modified-839efba934c8623f2dea31e7f8bb2857624c6908.zip
Fixed documentation changes for size, capacity, empty. Minor changes in some ex. and map shootout.
Diffstat (limited to 'docs')
-rw-r--r--docs/clist_api.md4
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/cqueue_api.md4
-rw-r--r--docs/csmap_api.md2
-rw-r--r--docs/csset_api.md4
5 files changed, 8 insertions, 8 deletions
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 9cd950bb..17ee3fa8 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -45,8 +45,8 @@ void clist_X_clear(clist_X* self);
void clist_X_copy(clist_X* self, const clist_X* other);
void clist_X_drop(clist_X* self); // destructor
-bool clist_X_empty(clist_X list);
-size_t clist_X_count(clist_X list); // size() in O(n) time
+bool clist_X_empty(const clist_X* list);
+size_t clist_X_count(const clist_X* list); // size() in O(n) time
clist_X_value* clist_X_front(const clist_X* self);
clist_X_value* clist_X_back(const clist_X* self);
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 5804112f..a624cfea 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -56,7 +56,7 @@ void cmap_X_swap(cmap_X* a, cmap_X* b);
void cmap_X_drop(cmap_X* self); // destructor
size_t cmap_X_size(const cmap_X* self);
-size_t cmap_X_capacity(const cmap_X self); // buckets * max_load_factor
+size_t cmap_X_capacity(const cmap_X* self); // buckets * max_load_factor
bool cmap_X_empty(const cmap_X* self );
size_t cmap_X_bucket_count(const cmap_X* self); // num. of allocated buckets
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 1f5469d6..a8be9e86 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -30,8 +30,8 @@ void cqueue_X_clear(cqueue_X* self);
void cqueue_X_copy(cqueue_X* self, const cqueue_X* other);
void cqueue_X_drop(cqueue_X* self); // destructor
-size_t cqueue_X_size(cqueue_X q);
-bool cqueue_X_empty(cqueue_X q);
+size_t cqueue_X_size(const cqueue_X* self);
+bool cqueue_X_empty(const cqueue_X* self);
cqueue_X_value* cqueue_X_front(const cqueue_X* self);
cqueue_X_value* cqueue_X_back(const cqueue_X* self);
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index b3cf668b..01b77cb4 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -51,7 +51,7 @@ void csmap_X_copy(csmap_X* self, const csmap_X* other);
void csmap_X_swap(csmap_X* a, csmap_X* b);
void csmap_X_drop(csmap_X* self); // destructor
-size_t csmap_X_size(const csmap_X self);
+size_t csmap_X_size(const csmap_X* self);
bool csmap_X_empty(const csmap_X* self);
bool csmap_X_capacity(const csmap_X* self);
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 66ce8505..30e57ca4 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -34,8 +34,8 @@ void csset_X_copy(csset_X* self, const csset_X* other);
void csset_X_swap(csset_X* a, csset_X* b);
void csset_X_drop(csset_X* self); // destructor
-size_t csset_X_size(csset_X set);
-bool csset_X_empty(csset_X set);
+size_t csset_X_size(const csset_X* self);
+bool csset_X_empty(const csset_X* self);
const csset_X_value* csset_X_get(const csset_X* self, i_keyraw rkey); // const get
csset_X_value* csset_X_get_mut(csset_X* self, i_keyraw rkey); // return NULL if not found