summaryrefslogtreecommitdiffhomepage
path: root/docs/cvec_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-11-03 11:30:06 +0100
committerTyge Løvset <[email protected]>2021-11-03 11:30:06 +0100
commite259ed7807dd9474cc94ba625db4dcd573431362 (patch)
tree0e83bf2d49a1f0ec43f9e9b0b74c69ef4fd97a1b /docs/cvec_api.md
parent73b1ed7c17b94647438c7e73738bf0820e5d57ad (diff)
downloadSTC-modified-e259ed7807dd9474cc94ba625db4dcd573431362.tar.gz
STC-modified-e259ed7807dd9474cc94ba625db4dcd573431362.zip
Changed container_X_get() and container_X_at() to return const value* (or const mapped*). Added container_X_getmut() for mutable version. Updated docs.
Diffstat (limited to 'docs/cvec_api.md')
-rw-r--r--docs/cvec_api.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 42ec944e..db119c14 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -35,9 +35,9 @@ cvec_X cvec_X_clone(cvec_X vec);
void cvec_X_clear(cvec_X* self);
void cvec_X_copy(cvec_X* self, cvec_X other);
-void cvec_X_shrink_to_fit(cvec_X* self);
void cvec_X_reserve(cvec_X* self, size_t cap);
void cvec_X_resize(cvec_X* self, size_t size, i_val fill);
+void cvec_X_shrink_to_fit(cvec_X* self);
void cvec_X_swap(cvec_X* a, cvec_X* b);
void cvec_X_del(cvec_X* self); // destructor
@@ -45,7 +45,14 @@ bool cvec_X_empty(cvec_X vec);
size_t cvec_X_size(cvec_X vec);
size_t cvec_X_capacity(cvec_X vec);
-cvec_X_value* cvec_X_at(const cvec_X* self, size_t idx);
+const cvec_X_value* cvec_X_at(const cvec_X* self, size_t idx);
+const cvec_X_value* cvec_X_get(const cvec_X* self, i_valraw raw); // return NULL if not found
+cvec_X_value* cvec_X_mutget(cvec_X* self, i_valraw raw); // mutable get
+cvec_X_iter cvec_X_find(const cvec_X* self, i_valraw raw);
+cvec_X_iter cvec_X_find_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw raw);
+cvec_X_iter cvec_X_bsearch(const cvec_X* self, i_valraw raw);
+cvec_X_iter cvec_X_bsearch_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw raw);
+
cvec_X_value* cvec_X_front(const cvec_X* self);
cvec_X_value* cvec_X_back(const cvec_X* self);
@@ -69,12 +76,6 @@ cvec_X_iter cvec_X_erase_n(cvec_X* self, size_t idx, size_t n);
cvec_X_iter cvec_X_erase_at(cvec_X* self, cvec_X_iter it);
cvec_X_iter cvec_X_erase_range(cvec_X* self, cvec_X_iter it1, cvec_X_iter it2);
-cvec_X_iter cvec_X_find(const cvec_X* self, i_valraw raw);
-cvec_X_iter cvec_X_find_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw raw);
-cvec_X_value* cvec_X_get(const cvec_X* self, i_valraw raw); // return NULL if not found
-cvec_X_iter cvec_X_bsearch(const cvec_X* self, i_valraw raw);
-cvec_X_iter cvec_X_bsearch_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw raw);
-
void cvec_X_sort(cvec_X* self);
void cvec_X_sort_range(cvec_X_iter i1, cvec_X_iter i2,
int(*cmp)(const i_val*, const i_val*));