summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-10-26 20:46:43 +0200
committerTyge Løvset <[email protected]>2021-10-26 20:46:43 +0200
commit0c6b41fd08bac55281ff9ad41b0d052171881651 (patch)
tree4a8107ce800eba0bd0d659d557133466e01da79c /docs
parent0f95c005891b0d4b3b2610fdba241cf78c372d81 (diff)
downloadSTC-modified-0c6b41fd08bac55281ff9ad41b0d052171881651.tar.gz
STC-modified-0c6b41fd08bac55281ff9ad41b0d052171881651.zip
Added some examples and updated docs. Removed cvec_X_erase() and cdeq_X_erase() - may be used wrong. Use cvec_X_erase_n() instead.
Fixed type-bug in cpque.h (same was in cqueue.h).
Diffstat (limited to 'docs')
-rw-r--r--docs/cdeq_api.md1
-rw-r--r--docs/cstack_api.md4
-rw-r--r--docs/cvec_api.md1
3 files changed, 4 insertions, 2 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 90a44293..4f188143 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -62,7 +62,6 @@ cdeq_X_iter_t cdeq_X_emplace_range(cdeq_X* self, cdeq_X_iter_t it,
cdeq_X_iter_t cdeq_X_emplace_range_p(cdeq_X* self, i_val* pos,
const i_val* p1, const i_val* p2);
-cdeq_X_iter_t cdeq_X_erase(cdeq_X* self, size_t idx);
cdeq_X_iter_t cdeq_X_erase_n(cdeq_X* self, size_t idx, size_t n);
cdeq_X_iter_t cdeq_X_erase_at(cdeq_X* self, cdeq_X_iter_t it);
cdeq_X_iter_t cdeq_X_erase_range(cdeq_X* self, cdeq_X_iter_t it1, cdeq_X_iter_t it2);
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 5b878ba4..c4a806e1 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -23,6 +23,8 @@ See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack
```c
cstack_X cstack_X_init(void);
+cstack_X cstack_with_capacity(size_t cap);
+cstack_X cstack_with_size(size_t size, i_val fill);
cstack_X cstack_X_clone(cstack_X st);
void cstack_X_clear(cstack_X* self);
@@ -32,8 +34,10 @@ void cstack_X_copy(cstack_X* self, cstack_X other);
void cstack_X_del(cstack_X* self); // destructor
size_t cstack_X_size(cstack_X st);
+size_t cstack_X_capacity(cstack_X st);
bool cstack_X_empty(cstack_X st);
cstack_X_value_t* cstack_X_top(const cstack_X* self);
+cstack_X_value_t* cstack_X_at(const cstack_X* self, size_t idx);
cstack_X_value_t* cstack_X_push(cstack_X* self, i_val value);
cstack_X_value_t* cstack_X_emplace(cstack_X* self, i_valraw raw);
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 3a78bf58..a14f6952 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -65,7 +65,6 @@ cvec_X_iter_t cvec_X_emplace_range(cvec_X* self, cvec_X_iter_t it,
cvec_X_iter_t cvec_X_emplace_range_p(cvec_X* self, i_val* pos,
const i_val* p1, const i_val* p2);
-cvec_X_iter_t cvec_X_erase(cvec_X* self, size_t idx);
cvec_X_iter_t cvec_X_erase_n(cvec_X* self, size_t idx, size_t n);
cvec_X_iter_t cvec_X_erase_at(cvec_X* self, cvec_X_iter_t it);
cvec_X_iter_t cvec_X_erase_range(cvec_X* self, cvec_X_iter_t it1, cvec_X_iter_t it2);