summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-04-09 20:58:11 +0200
committerTyge Løvset <[email protected]>2022-04-09 20:58:11 +0200
commit17e620fe3b3c42134a1139245c6590816c1ca6bf (patch)
tree9d5a35ac4ec66c83e4ca927c21e8013b13b1275d /docs
parent9e1ea5d14fb1835eb1ad1e45c8e8f02c9072ca57 (diff)
downloadSTC-modified-17e620fe3b3c42134a1139245c6590816c1ca6bf.tar.gz
STC-modified-17e620fe3b3c42134a1139245c6590816c1ca6bf.zip
- Switched from .._put() to .._push() as the "generic" method to add element to any container.
- Changed clist_X_insert()/emplace() to clist_X_insert_at()/emplace_at() to make it consistent with cvec/cdeq. - Updated documentation.
Diffstat (limited to 'docs')
-rw-r--r--docs/cdeq_api.md10
-rw-r--r--docs/clist_api.md6
-rw-r--r--docs/cmap_api.md4
-rw-r--r--docs/cpque_api.md1
-rw-r--r--docs/cqueue_api.md1
-rw-r--r--docs/cset_api.md2
-rw-r--r--docs/csmap_api.md2
-rw-r--r--docs/csset_api.md2
-rw-r--r--docs/cstack_api.md1
-rw-r--r--docs/cvec_api.md11
10 files changed, 22 insertions, 18 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index b884c62d..6749c5fd 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -51,18 +51,22 @@ cdeq_X_value* cdeq_X_emplace_front(cdeq_X* self, i_valraw raw);
void cdeq_X_pop_front(cdeq_X* self);
cdeq_X_value* cdeq_X_push_back(cdeq_X* self, i_val value);
+cdeq_X_value* cdeq_X_push(cdeq_X* self, i_val value); // alias for push_back()
cdeq_X_value* cdeq_X_emplace_back(cdeq_X* self, i_valraw raw);
-void cdeq_X_pop_back(cdeq_X* self);
+void cdeq_X_pop_back(cdeq_X* self);
+void cdeq_X_pop(cdeq_X* self); // alias for pop_back()
cdeq_X_iter cdeq_X_insert(cdeq_X* self, size_t idx, i_val value); // move value
cdeq_X_iter cdeq_X_insert_n(cdeq_X* self, size_t idx, const i_val[] arr, size_t n); // move arr values
cdeq_X_iter cdeq_X_insert_at(cdeq_X* self, cdeq_X_iter it, i_val value); // move value
+cdeq_X_iter cdeq_X_insert_range_p(cdeq_X* self, i_val* pos,
+ const i_val* p1, const i_val* p2);
cdeq_X_iter cdeq_X_emplace(cdeq_X* self, size_t idx, i_valraw raw);
cdeq_X_iter cdeq_X_emplace_n(cdeq_X* self, size_t idx, const i_valraw[] arr, size_t n);
cdeq_X_iter cdeq_X_emplace_at(cdeq_X* self, cdeq_X_iter it, i_valraw raw);
-cdeq_X_iter cdeq_X_emplace_range(cdeq_X* self, cdeq_X_iter it,
- cdeq_X_iter it1, cdeq_X_iter it2); // will clone
+cdeq_X_iter cdeq_X_emplace_range(cdeq_X* self, cdeq_X_iter it, // will clone
+ cdeq_X_iter it1, cdeq_X_iter it2);
cdeq_X_iter cdeq_X_emplace_range_p(cdeq_X* self, i_val* pos,
const i_val* p1, const i_val* p2);
diff --git a/docs/clist_api.md b/docs/clist_api.md
index bbb17796..c22d7bae 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -55,11 +55,11 @@ void clist_X_emplace_front(clist_X* self, i_valraw raw);
void clist_X_pop_front(clist_X* self);
void clist_X_push_back(clist_X* self, i_val value); // note: no pop_back().
-void clist_X_put(clist_X* self, i_val value); // alias for push_back().
+void clist_X_push(clist_X* self, i_val value); // alias for push_back().
void clist_X_emplace_back(clist_X* self, i_valraw raw);
-clist_X_iter clist_X_insert(clist_X* self, clist_X_iter it, i_val value); // return iter to new elem
-clist_X_iter clist_X_emplace(clist_X* self, clist_X_iter it, i_valraw raw);
+clist_X_iter clist_X_insert_at(clist_X* self, clist_X_iter it, i_val value); // return iter to new elem
+clist_X_iter clist_X_emplace_at(clist_X* self, clist_X_iter it, i_valraw raw);
clist_X_iter clist_X_erase_at(clist_X* self, clist_X_iter it); // return iter after it
clist_X_iter clist_X_erase_range(clist_X* self, clist_X_iter it1, clist_X_iter it2);
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 7f855041..ea0556b7 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -66,7 +66,7 @@ cmap_X_iter cmap_X_find(const cmap_X* self, i_keyraw rkey);
cmap_X_result cmap_X_insert(cmap_X* self, i_key key, i_val mapped); // no change if key in map
cmap_X_result cmap_X_insert_or_assign(cmap_X* self, i_key key, i_val mapped); // always update mapped
-cmap_X_result cmap_X_put(cmap_X* self, i_key key, i_val mapped); // alias for insert_or_assign
+cmap_X_result cmap_X_push(cmap_X* self, i_key key, i_val mapped); // alias for insert_or_assign
cmap_X_result cmap_X_emplace(cmap_X* self, i_keyraw rkey, i_valraw rmapped); // no change if rkey in map
cmap_X_result cmap_X_emplace_or_assign(cmap_X* self, i_keyraw rkey, i_valraw rmapped); // always update rmapped
@@ -107,7 +107,7 @@ bool c_memcmp_eq(const i_keyraw* a, const i_keyraw* b); //
| `cmap_X_key` | `i_key` | The key type |
| `cmap_X_mapped` | `i_val` | The mapped type |
| `cmap_X_value` | `struct { const i_key first; i_val second; }` | The value: key is immutable |
-| `cmap_X_result` | `struct { cmap_X_value *ref; bool inserted; }` | Result of insert/put/emplace |
+| `cmap_X_result` | `struct { cmap_X_value *ref; bool inserted; }` | Result of insert/emplace |
| `cmap_X_iter` | `struct { cmap_X_value *ref; ... }` | Iterator type |
## Examples
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index 055d2065..97ac70f5 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -42,7 +42,6 @@ i_val* cpque_X_top(const cpque_X* self);
void cpque_X_make_heap(cpque_X* self); // heapify the vector.
void cpque_X_push(cpque_X* self, i_val value);
-void cpque_X_put(cpque_X* self, i_val value); // alias for push()
void cpque_X_emplace(cpque_X* self, i_valraw raw); // converts from raw
void cpque_X_pop(cpque_X* self);
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 75105928..0ecae014 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -35,7 +35,6 @@ cqueue_X_value* cqueue_X_front(const cqueue_X* self);
cqueue_X_value* cqueue_X_back(const cqueue_X* self);
cqueue_X_value* cqueue_X_push(cqueue_X* self, i_val value);
-cqueue_X_value* cqueue_X_put(cqueue_X* self, i_val value); // alias for push()
cqueue_X_value* cqueue_X_emplace(cqueue_X* self, i_valraw raw);
void cqueue_X_pop(cqueue_X* self);
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 56c2669c..a7970baf 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -46,7 +46,7 @@ cset_X_value* cset_X_get_mut(cset_X* self, i_keyraw rkey);
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_push(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
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index e6f5515c..91818624 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -62,7 +62,7 @@ csmap_X_value* csmap_X_back(const csmap_X* self);
csmap_X_result csmap_X_insert(csmap_X* self, i_key key, i_val mapped); // no change if key in map
csmap_X_result csmap_X_insert_or_assign(csmap_X* self, i_key key, i_val mapped); // always update mapped
-csmap_X_result csmap_X_put(csmap_X* self, i_key key, i_val mapped); // alias for insert_or_assign()
+csmap_X_result csmap_X_push(csmap_X* self, i_key key, i_val mapped); // alias for insert_or_assign()
csmap_X_result csmap_X_emplace(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // no change if rkey in map
csmap_X_result csmap_X_emplace_or_assign(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // always update rmapped
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 0329a9df..b1bad3bc 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -42,7 +42,7 @@ csset_X_value* csset_X_find_it(const csset_X* self, i_keyraw rkey, csset_X
csset_X_iter csset_X_lower_bound(const csset_X* self, i_keyraw rkey); // find closest entry >= rkey
csset_X_result csset_X_insert(csset_X* self, i_key key);
-csset_X_result csset_X_put(csset_X* self, i_key key); // alias for insert()
+csset_X_result csset_X_push(csset_X* self, i_key key); // alias for insert()
csset_X_result csset_X_emplace(csset_X* self, i_keyraw rkey);
size_t csset_X_erase(csset_X* self, i_keyraw rkey);
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index e6348489..634f9ee7 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -41,7 +41,6 @@ i_val* cstack_X_top(const cstack_X* self);
const i_val* cstack_X_at(const cstack_X* self, size_t idx);
i_val* cstack_X_push(cstack_X* self, i_val value);
-i_val* cstack_X_put(cstack_X* self, i_val value); // alias for push
i_val* cstack_X_emplace(cstack_X* self, i_valraw raw);
void cstack_X_pop(cstack_X* self);
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index a1ac6a4f..9dcffdc7 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -60,18 +60,21 @@ cvec_X_value* cvec_X_back(const cvec_X* self);
cvec_X_value* cvec_X_emplace_back(cvec_X* self, i_valraw raw);
cvec_X_value* cvec_X_push_back(cvec_X* self, i_val value);
+cvec_X_value* cvec_X_push(cvec_X* self, i_val value); // alias for push_back
void cvec_X_pop_back(cvec_X* self);
-cvec_X_value* cvec_X_put(cvec_X* self, i_val value); // alias for push_back
void cvec_X_pop(cvec_X* self); // alias for pop_back
cvec_X_iter cvec_X_insert(cvec_X* self, size_t idx, i_val value); // move value
-cvec_X_iter cvec_X_insert_n(cvec_X* self, size_t idx, const i_val[] arr, size_t n); // move arr values
+cvec_X_iter cvec_X_insert_n(cvec_X* self, size_t idx, const i_val[] arr, size_t n); // move n values
cvec_X_iter cvec_X_insert_at(cvec_X* self, cvec_X_iter it, i_val value); // move value
+cvec_X_iter cvec_X_insert_range_p(cvec_X* self, i_val* pos,
+ const i_val* p1, const i_val* p2);
+cvec_X_iter cvec_X_emplace(cvec_X* self, size_t idx, i_valraw raw);
cvec_X_iter cvec_X_emplace_n(cvec_X* self, size_t idx, const i_valraw[] arr, size_t n);
cvec_X_iter cvec_X_emplace_at(cvec_X* self, cvec_X_iter it, i_valraw raw);
-cvec_X_iter cvec_X_emplace_range(cvec_X* self, cvec_X_iter it,
- cvec_X_iter it1, cvec_X_iter it2); // will clone
+cvec_X_iter cvec_X_emplace_range(cvec_X* self, cvec_X_iter it, // will clone
+ cvec_X_iter it1, cvec_X_iter it2);
cvec_X_iter cvec_X_emplace_range_p(cvec_X* self, i_val* pos,
const i_val* p1, const i_val* p2);