summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-02-04 16:42:43 +0100
committerTyge Løvset <[email protected]>2021-02-04 16:42:43 +0100
commit0f8091e48049755007f3de7742fab65c62786f5f (patch)
treed216ea944ea95943a3492ca3438481e25557a93f /docs
parent0a02638f787d6b7892535daa8ba67c2154a2da77 (diff)
downloadSTC-modified-0f8091e48049755007f3de7742fab65c62786f5f.tar.gz
STC-modified-0f8091e48049755007f3de7742fab65c62786f5f.zip
Fixup in API regarding _at() - more consistent.
Diffstat (limited to 'docs')
-rw-r--r--docs/ccommon_api.md1
-rw-r--r--docs/cdeq_api.md20
-rw-r--r--docs/clist_api.md5
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/cvec_api.md12
5 files changed, 20 insertions, 20 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md
index 210c75ae..3214fbef 100644
--- a/docs/ccommon_api.md
+++ b/docs/ccommon_api.md
@@ -57,7 +57,6 @@ c_forrange (i, int, 30, 0, -5) printf(" %d", i);
using_csset(x, int);
...
c_init (csset_x, set, {23, 3, 7, 5, 12});
-double sum = 0;
c_foreach (i, csset_x, set) printf(" %d", *i.ref);
// 3 5 7 12 23
csset_x_iter_t it = csset_x_find(&set, 7);
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index ca4855da..9aa8cd4b 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -56,6 +56,10 @@ 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_iter_t cdeq_X_find(const cdeq_X* self, RawValue raw);
+cdeq_X_iter_t cdeq_X_find_in_range(const cdeq_X* self,
+ cdeq_X_iter_t first, cdeq_X_iter_t finish, RawValue raw);
+
void cdeq_X_push_n(cdeq_X *self, const cdeq_X_rawvalue_t arr[], size_t size);
void cdeq_X_push_front(cdeq_X* self, Value value);
void cdeq_X_push_back(cdeq_X* self, Value value);
@@ -64,24 +68,20 @@ void cdeq_X_emplace_back(cdeq_X* self, RawValue raw);
void cdeq_X_pop_front(cdeq_X* self);
void cdeq_X_pop_back(cdeq_X* self);
-cdeq_X_iter_t cdeq_X_emplace(cdeq_X* self, cdeq_X_iter_t pos, RawValue raw);
-cdeq_X_iter_t cdeq_X_emplace_at(cdeq_X* self, size_t idx, RawValue raw);
-cdeq_X_iter_t cdeq_X_insert(cdeq_X* self, cdeq_X_iter_t pos, Value value);
-cdeq_X_iter_t cdeq_X_insert_at(cdeq_X* self, size_t idx, Value value);
+cdeq_X_iter_t cdeq_X_emplace(cdeq_X* self, size_t idx, RawValue raw);
+cdeq_X_iter_t cdeq_X_emplace_at(cdeq_X* self, cdeq_X_iter_t pos, RawValue raw);
+cdeq_X_iter_t cdeq_X_insert(cdeq_X* self, size_t idx, Value value);
+cdeq_X_iter_t cdeq_X_insert_at(cdeq_X* self, cdeq_X_iter_t pos, Value value);
cdeq_X_iter_t cdeq_X_insert_range(cdeq_X* self, cdeq_X_iter_t pos,
cdeq_X_iter_t first, cdeq_X_iter_t finish);
cdeq_X_iter_t cdeq_X_insert_range_p(cdeq_X* self, cdeq_X_value_t* pos,
const cdeq_X_value_t* pfirst, const cdeq_X_value_t* pfinish);
-cdeq_X_iter_t cdeq_X_erase(cdeq_X* self, cdeq_X_iter_t pos);
-cdeq_X_iter_t cdeq_X_erase_n(cdeq_X* self, size_t idx, size_t n);
+cdeq_X_iter_t cdeq_X_erase(cdeq_X* self, size_t idx, size_t n);
+cdeq_X_iter_t cdeq_X_erase_at(cdeq_X* self, cdeq_X_iter_t pos);
cdeq_X_iter_t cdeq_X_erase_range(cdeq_X* self, cdeq_X_iter_t first, cdeq_X_iter_t finish);
cdeq_X_iter_t cdeq_X_erase_range_p(cdeq_X* self, cdeq_X_value_t* pfirst, cdeq_X_value_t* pfinish);
-cdeq_X_iter_t cdeq_X_find(const cdeq_X* self, RawValue raw);
-cdeq_X_iter_t cdeq_X_find_in_range(const cdeq_X* self,
- cdeq_X_iter_t first, cdeq_X_iter_t finish, RawValue raw);
-
void cdeq_X_sort(cdeq_X* self);
void cdeq_X_sort_with(cdeq_X* self, size_t ifirst, size_t ifinish,
int(*cmp)(const cdeq_X_value_t*, const cdeq_X_value_t*));
diff --git a/docs/clist_api.md b/docs/clist_api.md
index dd3a9a49..d693a052 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -78,8 +78,9 @@ clist_X_iter_t clist_X_splice_back(clist_X* self, clist_X* other);
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);
+clist_X_iter_t clist_X_find_before(const clist_X* self, RawValue raw);
+clist_X_iter_t clist_X_find_before_in_range(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);
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 4a39e3ae..61441fb7 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -104,7 +104,7 @@ uint32_t c_default_hash32(const void* data, size_t len);
| `cmap_X_mapped_t` | `Mapped` | The mapped type |
| `cmap_X_value_t` | `struct { Key first; Mapped second; }` | The value type |
| `cmap_X_rawvalue_t` | `struct { RawKey first; RawMapped second; }` | RawKey + RawMapped type |
-| `cmap_X_result_t` | `struct { cmap_X_value_t first; bool second; }` | Result of insert/put/emplace |
+| `cmap_X_result_t` | `struct { cmap_X_value_t *first; bool second; }`| Result of insert/put/emplace |
| `cmap_X_iter_t` | `struct { cmap_X_value_t *ref; ... }` | Iterator type |
`c_default_hash` requires Key to be 16-bit aligned, and size to be a multiple of 16. There is also a `c_default_hash32` which is slightly faster.
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index aeaf8ca7..7c523f02 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -65,17 +65,17 @@ void cvec_X_emplace_back(cvec_X* self, RawValue raw);
void cvec_X_push_back(cvec_X* self, Value value);
void cvec_X_pop_back(cvec_X* self);
-cvec_X_iter_t cvec_X_emplace(cvec_X* self, cvec_X_iter_t pos, RawValue raw);
-cvec_X_iter_t cvec_X_emplace_at(cvec_X* self, size_t idx, RawValue raw);
-cvec_X_iter_t cvec_X_insert(cvec_X* self, cvec_X_iter_t pos, Value value);
-cvec_X_iter_t cvec_X_insert_at(cvec_X* self, size_t idx, Value value);
+cvec_X_iter_t cvec_X_emplace(cvec_X* self, size_t idx, RawValue raw);
+cvec_X_iter_t cvec_X_emplace_at(cvec_X* self, cvec_X_iter_t pos, RawValue raw);
+cvec_X_iter_t cvec_X_insert(cvec_X* self, size_t idx, Value value);
+cvec_X_iter_t cvec_X_insert_at(cvec_X* self, cvec_X_iter_t pos, Value value);
cvec_X_iter_t cvec_X_insert_range(cvec_X* self, cvec_X_iter_t pos,
cvec_X_iter_t first, cvec_X_iter_t finish);
cvec_X_iter_t cvec_X_insert_range_p(cvec_X* self, cvec_X_value_t* pos,
const cvec_X_value_t* pfirst, const cvec_X_value_t* pfinish);
-cvec_X_iter_t cvec_X_erase(cvec_X* self, cvec_X_iter_t pos);
-cvec_X_iter_t cvec_X_erase_n(cvec_X* self, size_t idx, size_t n);
+cvec_X_iter_t cvec_X_erase(cvec_X* self, size_t idx, size_t n);
+cvec_X_iter_t cvec_X_erase_at(cvec_X* self, cvec_X_iter_t pos);
cvec_X_iter_t cvec_X_erase_range(cvec_X* self, cvec_X_iter_t first, cvec_X_iter_t finish);
cvec_X_iter_t cvec_X_erase_range_p(cvec_X* self, cvec_X_value_t* pfirst, cvec_X_value_t* pfinish);