summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-04-15 22:08:12 +0200
committerTyge Løvset <[email protected]>2022-04-15 22:08:12 +0200
commitfa261ddd307de9b7bb2965a066fd83b66d8d83a7 (patch)
treef89c186fdaaedb8ab34c223e1a75f4d25db612ab /docs
parent99acd2149f3f8996249b3ef82f7490dd098783d7 (diff)
downloadSTC-modified-fa261ddd307de9b7bb2965a066fd83b66d8d83a7.tar.gz
STC-modified-fa261ddd307de9b7bb2965a066fd83b66d8d83a7.zip
Updated README.md docs on template args! Reverted to put() as alias for insert_or_assign() for maps. Reverted/added push_back()/emplace_back()/pop_back() to cstack.
Diffstat (limited to 'docs')
-rw-r--r--docs/cdeq_api.md2
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/cset_api.md1
-rw-r--r--docs/csmap_api.md2
-rw-r--r--docs/csset_api.md1
-rw-r--r--docs/cstack_api.md3
-rw-r--r--docs/cvec_api.md5
7 files changed, 8 insertions, 8 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 1bc70bfa..69a40986 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -51,7 +51,6 @@ 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);
@@ -61,7 +60,6 @@ cdeq_X_iter cdeq_X_insert_at(cdeq_X* self, cdeq_X_iter it, i_val 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, // will clone
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index ea0556b7..4c945a25 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_push(cmap_X* self, i_key key, i_val mapped); // alias for insert_or_assign
+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_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
diff --git a/docs/cset_api.md b/docs/cset_api.md
index a7970baf..4d97b94f 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -46,7 +46,6 @@ 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_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 91818624..e6f5515c 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_push(csmap_X* self, i_key key, i_val mapped); // alias for insert_or_assign()
+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_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 b1bad3bc..76b26eee 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -42,7 +42,6 @@ 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_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 634f9ee7..299ea1c6 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -42,8 +42,11 @@ 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_emplace(cstack_X* self, i_valraw raw);
+i_val* cstack_X_push_back(cstack_X* self, i_val value); // alias for push()
+i_val* cstack_X_emplace_back(cstack_X* self, i_valraw r); // alias for emplace()
void cstack_X_pop(cstack_X* self);
+void cstack_X_pop_back(cstack_X* self); // alias for pop()
cstack_X_iter cstack_X_begin(const cstack_X* self);
cstack_X_iter cstack_X_end(const cstack_X* self);
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 9dcffdc7..e8669395 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -58,9 +58,11 @@ cvec_X_iter cvec_X_bsearch_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw r
cvec_X_value* cvec_X_front(const cvec_X* self);
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_emplace_back(cvec_X* self, i_valraw raw);
cvec_X_value* cvec_X_push(cvec_X* self, i_val value); // alias for push_back
+cvec_X_value* cvec_X_emplace(cvec_X* self, i_valraw raw); // alias for emplace_back
+
void cvec_X_pop_back(cvec_X* self);
void cvec_X_pop(cvec_X* self); // alias for pop_back
@@ -70,7 +72,6 @@ cvec_X_iter cvec_X_insert_at(cvec_X* self, cvec_X_iter it, i_val 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, // will clone