summaryrefslogtreecommitdiffhomepage
path: root/docs/cvec_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-04-08 17:13:15 +0200
committerTyge Løvset <[email protected]>2022-04-08 17:13:15 +0200
commit770764da916b9e3783f2a95b2da62cb930b6702b (patch)
treee68c5805afe38023a1dd386eb098dc0e3f1eecaf /docs/cvec_api.md
parent3eb276a712cc5edad798e2c75acfe125de831243 (diff)
downloadSTC-modified-770764da916b9e3783f2a95b2da62cb930b6702b.tar.gz
STC-modified-770764da916b9e3783f2a95b2da62cb930b6702b.zip
Added cvec_X_lower_bound() function for sorted array search.
Diffstat (limited to 'docs/cvec_api.md')
-rw-r--r--docs/cvec_api.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index ef145b94..7aef79d9 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -50,8 +50,10 @@ const cvec_X_value* cvec_X_get(const cvec_X* self, i_valraw raw);
cvec_X_value* cvec_X_get_mut(cvec_X* self, i_valraw raw); // get mutable value
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);
+ // On sorted vectors:
+cvec_X_iter cvec_X_bsearch(const cvec_X* self, i_valraw raw); // at elem == raw, else end
+cvec_X_iter cvec_X_lower_bound(const cvec_X* self, i_valraw raw); // at first elem >= raw, else end
+cvec_X_iter cvec_X_bsearch_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw raw, cvec_X_iter* lower_bound = NULL);
cvec_X_value* cvec_X_front(const cvec_X* self);
cvec_X_value* cvec_X_back(const cvec_X* self);