summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-18 10:49:38 +0100
committerGitHub <[email protected]>2021-01-18 10:49:38 +0100
commit5d53c7ac0227846782d5149b63072b863bd33f01 (patch)
tree356001d64a7f3cc8ac2e43533ad5fe9d542268e4 /docs
parentda46afb9df1037e21d42a527300d0b7538ee5fa3 (diff)
downloadSTC-modified-5d53c7ac0227846782d5149b63072b863bd33f01.tar.gz
STC-modified-5d53c7ac0227846782d5149b63072b863bd33f01.zip
Update clist_api.md
Diffstat (limited to 'docs')
-rw-r--r--docs/clist_api.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 267361d6..99c399fa 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -61,14 +61,15 @@ 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);
-void clist_X_push_n(clist_X *self, const clist_X_rawvalue_t arr[], size_t size);
-void clist_X_emplace_back(clist_X* self, RawValue ref);
-void clist_X_push_back(clist_X* self, Value value);
-
void clist_X_emplace_front(clist_X* self, RawValue raw);
void clist_X_push_front(clist_X* self, Value value);
void clist_X_pop_front(clist_X* self);
+ // non-std: push back, complexity O(1)
+void clist_X_push_n(clist_X *self, const clist_X_rawvalue_t arr[], size_t size);
+void clist_X_emplace_back(clist_X* self, RawValue ref);
+void clist_X_push_back(clist_X* self, Value value);
+
clist_X_iter_t clist_X_emplace_after(clist_X* self, clist_X_iter_t it, RawValue raw);
clist_X_iter_t clist_X_insert_after(clist_X* self, clist_X_iter_t it, Value raw);
@@ -80,13 +81,14 @@ clist_X_iter_t clist_X_splice_after(clist_X* self, clist_X_iter_t it, clist
clist_X_iter_t clist_X_splice_front(clist_X* self, clist_X* other);
clist_X_iter_t clist_X_splice_back(clist_X* self, clist_X* other);
- // non-std: note: return range (it1, it2] - excluding it1, including it2:
+ // non-std: note: returns range (it1, it2] - excluding it1, including it2:
clist_X clist_X_splice_out(clist_X* self, clist_X_iter_t it1, clist_X_iter_t it2);
clist_X_iter_t clist_X_find(const clist_X* self, RawValue raw);
clist_X_iter_t clist_X_find_before(const clist_X* self,
clist_X_iter_t it1, clist_X_iter_t it2, RawValue raw);
+ // std: removes all elements equal to raw
size_t clist_X_remove(clist_X* self, RawValue raw);
void clist_X_sort(clist_X* self);
@@ -101,7 +103,7 @@ clist_X_iter_t clist_X_fwd(clist_X_iter it, size_t n);
clist_X_value_t clist_X_value_clone(clist_X_value_t val);
```
-The `clist_X_splice_out(self, it1, it2)` can be combined with `clist_X_splice_after(self, pos, other)` to mimic c++ `std::forward_list::splice_after(pos, other, it1, it2)`. Note however, that `it2` is included in elements to be spliced, unlike with `std::forward_list()`. E.g, splice in 2, 3 after 10 in L2:
+The `clist_X_splice_out(self, it1, it2)` can be combined with `clist_X_splice_after(self, pos, other)` to mimic c++ `std::forward_list::splice_after(pos, other, it1, it2)`. Note however that *it2* is included in elements to be spliced, unlike with `std::forward_list()`. E.g, splice in `[2, 3]` after `10` in *L2*:
```c
c_init (clist_i, L1, {1, 2, 3, 4, 5});
c_init (clist_i, L2, {10, 20, 30, 40, 50});