summaryrefslogtreecommitdiffhomepage
path: root/docs/cbits_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-24 15:20:41 +0100
committerTyge Løvset <[email protected]>2021-03-24 15:20:41 +0100
commitdba28f4d568439545785932ec273a1bc19abee24 (patch)
tree9b9d6c27903eb27955a346f0d7b585b639d95896 /docs/cbits_api.md
parent52f53e8c8ea9320e2af86d6e1a09f1416a73d51c (diff)
downloadSTC-modified-dba28f4d568439545785932ec273a1bc19abee24.tar.gz
STC-modified-dba28f4d568439545785932ec273a1bc19abee24.zip
Removed separate ## Header section in docs.
Diffstat (limited to 'docs/cbits_api.md')
-rw-r--r--docs/cbits_api.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/cbits_api.md b/docs/cbits_api.md
index 80a20c6f..86a91e1b 100644
--- a/docs/cbits_api.md
+++ b/docs/cbits_api.md
@@ -27,16 +27,16 @@ void cbits_resize(cbits* self, size_t size, bool value);
void cbits_del(cbits* self);
cbits* cbits_assign(cbits* self, cbits other);
-cbits* cbits_take(cbits* self, cbits other);
-cbits cbits_move(cbits* self);
+cbits* cbits_take(cbits* self, cbits other); // give other to self
+cbits cbits_move(cbits* self); // transfer self to caller
size_t cbits_size(cbits set);
-size_t cbits_count(cbits set);
+size_t cbits_count(cbits set); // count number of bits set
bool cbits_test(cbits set, size_t i);
-bool cbits_at(cbits set, size_t i); // same as cbits_test()
-bool cbits_is_subset(cbits set, cbits other);
-bool cbits_is_disjoint(cbits set, cbits other);
+bool cbits_at(cbits set, size_t i); // same as cbits_test()
+bool cbits_is_subset(cbits set, cbits other); // is set a subset of other?
+bool cbits_is_disjoint(cbits set, cbits other); // xor test
char* cbits_to_str(cbits set, char* str, size_t start, intptr_t stop);
void cbits_set(cbits *self, size_t i);
@@ -49,7 +49,7 @@ void cbits_flip_all(cbits *self);
void cbits_intersect(cbits *self, cbits other);
void cbits_union(cbits *self, cbits other);
-void cbits_xor(cbits *self, cbits other);
+void cbits_xor(cbits *self, cbits other); // set of disjoint bits
```
## Types