summaryrefslogtreecommitdiffhomepage
path: root/docs/cset_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-12-19 21:39:25 +0100
committerTyge Løvset <[email protected]>2021-12-19 21:39:25 +0100
commit0c3d711c2541aebe9a44fecb732e096bed14f72c (patch)
tree0d9c6dbe393d24fccd12107a3ec08f468656ce73 /docs/cset_api.md
parent09b696eab6ae640f6c1e07178d49fcd8646e1737 (diff)
downloadSTC-modified-0c3d711c2541aebe9a44fecb732e096bed14f72c.tar.gz
STC-modified-0c3d711c2541aebe9a44fecb732e096bed14f72c.zip
Global rename of `_equ\b` => `_eq`. In practice `i_equ` must renamed to `i_eq` in user code if used.
Diffstat (limited to 'docs/cset_api.md')
-rw-r--r--docs/cset_api.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/cset_api.md b/docs/cset_api.md
index b70f5fb9..2ce43309 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -8,13 +8,13 @@ A **cset** is an associative container that contains a set of unique objects of
```c
#define i_key // key: REQUIRED
-#define i_hash // hash func: REQUIRED IF i_keyraw is a non-pod type
#define i_cmp // three-way compare two i_keyraw*: REQUIRED IF i_keyraw is a non-integral type
-#define i_equ // equality comparison two i_keyraw*: ALTERNATIVE to i_cmp
+#define i_hash // hash func: REQUIRED IF i_keyraw is a non-pod type
+#define i_eq // equality comparison two i_keyraw*: !i_cmp will be used if not defined.
#define i_drop // destroy key func - defaults to empty destruct
#define i_keyraw // convertion "raw" type - defaults to i_key
-#define i_keyfrom // convertion func i_keyraw => i_key - defaults to plain copy
-#define i_keyto // convertion func i_key* => i_keyraw - defaults to plain copy
+#define i_keyfrom // convertion func i_keyraw => i_key - defaults to plain copy
+#define i_keyto // convertion func i_key* => i_keyraw - defaults to plain copy
#define i_tag // defaults to i_key
#include <stc/cset.h>
```