summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-07 22:28:32 +0100
committerTyge Løvset <[email protected]>2021-03-07 22:28:32 +0100
commitcbcee23091bf58971de8f94adc54e1406177bda5 (patch)
tree90f8238a371e07b4bfbe6fd00bd35b70a949dc7e /docs
parent15dcc16cac8f5353d657fe6511eb1a01be347fa0 (diff)
downloadSTC-modified-cbcee23091bf58971de8f94adc54e1406177bda5.tar.gz
STC-modified-cbcee23091bf58971de8f94adc54e1406177bda5.zip
Corrected more constness.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md16
-rw-r--r--docs/cdeq_api.md6
-rw-r--r--docs/clist_api.md4
-rw-r--r--docs/cqueue_api.md4
-rw-r--r--docs/cset_api.md4
-rw-r--r--docs/csset_api.md4
-rw-r--r--docs/cvec_api.md6
7 files changed, 22 insertions, 22 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index cdf1bf96..0e0d8996 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -42,16 +42,16 @@ size_t carrayNX_xdim(carrayNX arr);
size_t carrayNX_ydim(carrayNX arr); // not N=3
size_t carrayNX_zdim(carrayNX arr); // only N=3
-Value* carray1X_at(carray1X *self, size_t x);
-Value* carray2X_at(carray2X *self, size_t y, size_t x);
-Value* carray3X_at(carray3X *self, size_t z, size_t y, size_t x);
+Value* carray1X_at(const carray1X *self, size_t x);
+Value* carray2X_at(const carray2X *self, size_t y, size_t x);
+Value* carray3X_at(const carray3X *self, size_t z, size_t y, size_t x);
-carray1X carray2X_at1(carray2X *self, size_t y);
-carray2X carray3X_at1(carray3X *self, size_t z);
-carray1X carray3X_at2(carray3X *self, size_t z, size_t y);
+carray1X carray2X_at1(const carray2X *self, size_t y);
+carray2X carray3X_at1(const carray3X *self, size_t z);
+carray1X carray3X_at2(const carray3X *self, size_t z, size_t y);
-carrayNX_iter_t carrayNX_begin(carrayNX* self);
-carrayNX_iter_t carrayNX_end(carrayNX* self);
+carrayNX_iter_t carrayNX_begin(const carrayNX* self);
+carrayNX_iter_t carrayNX_end(const carrayNX* self);
void carrayNX_next(carrayNX_iter_t* it);
carrayNX_value_t* carrayNX_itval(carrayNX_iter_t it);
```
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 1f0ef0ce..1783b948 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -51,9 +51,9 @@ bool cdeq_X_empty(cdeq_X deq);
size_t cdeq_X_size(cdeq_X deq);
size_t cdeq_X_capacity(cdeq_X deq);
-cdeq_X_value_t* cdeq_X_at(cdeq_X* self, size_t idx);
-cdeq_X_value_t* cdeq_X_front(cdeq_X* self);
-cdeq_X_value_t* cdeq_X_back(cdeq_X* self);
+cdeq_X_value_t* cdeq_X_at(const cdeq_X* self, size_t idx);
+cdeq_X_value_t* cdeq_X_front(const cdeq_X* self);
+cdeq_X_value_t* cdeq_X_back(const cdeq_X* self);
void cdeq_X_push_front(cdeq_X* self, Value value);
void cdeq_X_push_back(cdeq_X* self, Value value);
diff --git a/docs/clist_api.md b/docs/clist_api.md
index a63bfbd9..a3497703 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -50,8 +50,8 @@ void clist_X_del(clist_X* self); // destructor
bool clist_X_empty(clist_X list);
size_t clist_X_size(clist_X list); // note: O(n)
-clist_X_value_t* clist_X_front(clist_X* self);
-clist_X_value_t* clist_X_back(clist_X* self);
+clist_X_value_t* clist_X_front(const clist_X* self);
+clist_X_value_t* clist_X_back(const clist_X* self);
void clist_X_push_front(clist_X* self, Value value);
void clist_X_emplace_front(clist_X* self, RawValue raw);
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 4890a4ea..30b6d4d0 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -31,8 +31,8 @@ void cqueue_X_del(cqueue_X* self); // destructor
size_t cqueue_X_size(cqueue_X q);
bool cqueue_X_empty(cqueue_X q);
-cqueue_X_value_t* cqueue_X_front(cqueue_X* self);
-cqueue_X_value_t* cqueue_X_back(cqueue_X* self);
+cqueue_X_value_t* cqueue_X_front(const cqueue_X* self);
+cqueue_X_value_t* cqueue_X_back(const cqueue_X* self);
void cqueue_X_push(cqueue_X* self, cqueue_X_value_t value);
void cqueue_X_emplace(cqueue_X* self, cqueue_X_rawvalue_t raw);
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 5629ae07..6d5f9b2e 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -55,8 +55,8 @@ void cset_X_emplace_n(cset_X* self, const RawKey arr[], size_t si
size_t cset_X_erase(cset_X* self, RawKey rkey);
cset_X_iter_t cset_X_erase_at(cset_X* self, cset_X_iter_t pos);
-cset_X_iter_t cset_X_begin(cset_X* self);
-cset_X_iter_t cset_X_end(cset_X* self);
+cset_X_iter_t cset_X_begin(const cset_X* self);
+cset_X_iter_t cset_X_end(const cset_X* self);
void cset_X_next(cset_X_iter_t* it);
cset_X_value_t* cset_X_itval(cset_X_iter_t it);
diff --git a/docs/csset_api.md b/docs/csset_api.md
index cc1c23c0..5d593b6f 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -50,8 +50,8 @@ void csset_X_emplace_n(csset_X* self, const RawKey arr[], size_t
size_t csset_X_erase(csset_X* self, RawKey rkey);
csset_X_iter_t csset_X_erase_at(csset_X* self, csset_X_iter_t pos);
-csset_X_iter_t csset_X_begin(csset_X* self);
-csset_X_iter_t csset_X_end(csset_X* self);
+csset_X_iter_t csset_X_begin(const csset_X* self);
+csset_X_iter_t csset_X_end(const csset_X* self);
void csset_X_next(csset_X_iter_t* it);
csset_X_value_t* csset_X_itval(csset_X_iter_t it);
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 5b6cd61a..ac9a0397 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -55,9 +55,9 @@ bool cvec_X_empty(cvec_X vec);
size_t cvec_X_size(cvec_X vec);
size_t cvec_X_capacity(cvec_X vec);
-cvec_X_value_t* cvec_X_at(cvec_X* self, size_t idx);
-cvec_X_value_t* cvec_X_front(cvec_X* self);
-cvec_X_value_t* cvec_X_back(cvec_X* self);
+cvec_X_value_t* cvec_X_at(const cvec_X* self, size_t idx);
+cvec_X_value_t* cvec_X_front(const cvec_X* self);
+cvec_X_value_t* cvec_X_back(const cvec_X* self);
void cvec_X_push_back(cvec_X* self, Value value);
void cvec_X_emplace_back(cvec_X* self, RawValue raw);