diff options
| author | Tyge Løvset <[email protected]> | 2021-09-17 19:56:04 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-09-17 19:56:04 +0200 |
| commit | 0d252463192cf3391d9c41e47574a560b7377bee (patch) | |
| tree | d234a699ee8ae8f8bca2819e9b0cc0ff4599bbe5 /docs/cpque_api.md | |
| parent | 103d8d501cf9a3cb3c882e05553e79a5731a0c26 (diff) | |
| download | STC-modified-0d252463192cf3391d9c41e47574a560b7377bee.tar.gz STC-modified-0d252463192cf3391d9c41e47574a560b7377bee.zip | |
Updated docs.
Added i_key_csptr, i_val_csptr input macros for very easy usage of shared pointers in containers.
Diffstat (limited to 'docs/cpque_api.md')
| -rw-r--r-- | docs/cpque_api.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/cpque_api.md b/docs/cpque_api.md index dba3fe3a..343215bf 100644 --- a/docs/cpque_api.md +++ b/docs/cpque_api.md @@ -8,13 +8,13 @@ See the c++ class [std::priority_queue](https://en.cppreference.com/w/cpp/contai ## Header file and declaration ```c -#define i_tag -#define i_val // required -#define i_cmp // required if i_val is a struct -#define i_valdel -#define i_valfrom -#define i_valto -#define i_valraw +#define i_tag // defaults to i_val name +#define i_val // value: REQUIRED +#define i_cmp // three-way compare two i_valraw* : REQUIRED IF i_valraw is a non-integral type +#define i_valraw // convertion "raw" type - defaults to i_val +#define i_valfrom // convertion func i_valraw => i_val - defaults to plain copy +#define i_valto // convertion func i_val* => i_valraw - defaults to plain copy +#define i_valdel // destroy value func - defaults to empty destruct #include <stc/cpque.h> ``` `X` should be replaced by the value of i_tag in all of the following documentation. |
