diff options
| author | Tyge Løvset <[email protected]> | 2020-11-30 19:05:57 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2020-11-30 19:05:57 +0100 |
| commit | 9eaac2daf60d12c461d47f601c715436aae1b819 (patch) | |
| tree | fb1725e28c68b135f2441f9267824b3714778ddf /docs/cmap_api.md | |
| parent | 2eb2033e41b04a137f9cf950ff313cfe32d2b049 (diff) | |
| download | STC-modified-9eaac2daf60d12c461d47f601c715436aae1b819.tar.gz STC-modified-9eaac2daf60d12c461d47f601c715436aae1b819.zip | |
Renamed tag template param name from $ to T.
Diffstat (limited to 'docs/cmap_api.md')
| -rw-r--r-- | docs/cmap_api.md | 88 |
1 files changed, 44 insertions, 44 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md index 0b9cd6a7..1f6d13ff 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -11,14 +11,14 @@ This describes the API of circular singly linked list type **cmap**. #define using_cmap_strkey(Mapped, mappedDestroy=c_default_del) -#define using_cmap_strval($, Key, keyEquals=c_default_equals, +#define using_cmap_strval(T, Key, keyEquals=c_default_equals, keyHash=c_default_hash16, keyDestroy=c_default_del, RawKey=Key, keyToRaw=c_default_to_raw, keyFromRaw=c_default_from_raw) -#define using_cmap($, Key, Mapped, mappedDestroy=c_default_del, +#define using_cmap(T, Key, Mapped, mappedDestroy=c_default_del, keyEqualsRaw=c_default_equals, keyHashRaw=c_default_hash16, keyDestroy=c_default_del, @@ -29,8 +29,8 @@ This describes the API of circular singly linked list type **cmap**. mappedFromRaw=c_default_from_raw) ``` The macro `using_cmap()` can be instantiated with 3, 4, 6, 10, or 12 arguments in the global scope. -Default values are given above for args not specified. `$` is a type tag name and -will affect the names of all cmap types and methods. E.g. declaring `using_cmap(my, int);`, `$` should +Default values are given above for args not specified. `T` is a type tag name and +will affect the names of all cmap types and methods. E.g. declaring `using_cmap(my, int);`, `T` should be replaced by `my` in all of the following documentation. `using_cmap_str()` is a predefined macro for `using_cmap(str, cstr_t, ...)`. @@ -39,21 +39,21 @@ be replaced by `my` in all of the following documentation. | Type name | Type definition | Used to represent... | |:---------------------|:--------------------------------------|:-----------------------------------| -| `cmap_$` | `struct {` | The cmap type | -| | ` cmap_$_value_t* table; | | +| `cmap_T` | `struct {` | The cmap type | +| | ` cmap_T_value_t* table; | | | | ` uint8_t* _hashx;` | | | | ` ...;` | | | | `}` | | -| `cmap_$_key_t` | `Key` | The cmap key type | -| `cmap_$_mapped_t` | `Mapped` | cmap mapped type | -| `cmap_$_value_t` | `struct {` | The cmap value type | -| | ` cmap_$_key_t first; | | -| | ` cmap_$_mapped_t second;` | | +| `cmap_T_key_t` | `Key` | The cmap key type | +| `cmap_T_mapped_t` | `Mapped` | cmap mapped type | +| `cmap_T_value_t` | `struct {` | The cmap value type | +| | ` cmap_T_key_t first; | | +| | ` cmap_T_mapped_t second;` | | | | `}` | | -| `cmap_$_input_t` | `cmap_$_value_t` | cmap input type | -| `cmap_$_rawvalue_t` | `RawMapped` | cmap raw value type | -| `cmap_$_iter_t` | `struct {` | cmap iterator | -| | ` cmap_$_value_t* val;` | | +| `cmap_T_input_t` | `cmap_T_value_t` | cmap input type | +| `cmap_T_rawvalue_t` | `RawMapped` | cmap raw value type | +| `cmap_T_iter_t` | `struct {` | cmap iterator | +| | ` cmap_T_value_t* val;` | | | | ` ...;` | | | | `}` | | @@ -78,45 +78,45 @@ All cmap definitions and prototypes may be included in your C source file by inc ### Construction -The interfaces to create a cmap_$ object: +The interfaces to create a cmap_T object: ```c -cmap_$ cmap_$_init(void); -cmap_$ cmap_$_with_capacity(size_t cap); -void cmap_$_set_load_factors(cmap_$* self, float max, float shrink); +cmap_T cmap_T_init(void); +cmap_T cmap_T_with_capacity(size_t cap); +void cmap_T_set_load_factors(cmap_T* self, float max, float shrink); -void cmap_$_clear(cmap_$* self); -void cmap_$_reserve(cmap_$* self, size_t size); -void cmap_$_swap(cmap_$* a, cmap_$* b); +void cmap_T_clear(cmap_T* self); +void cmap_T_reserve(cmap_T* self, size_t size); +void cmap_T_swap(cmap_T* a, cmap_T* b); -void cmap_$_del(cmap_$* self); +void cmap_T_del(cmap_T* self); -bool cmap_$_empty(cmap_$ m); -size_t cmap_$_size(cmap_$ m); -size_t cmap_$_bucket_count(cmap_$ m); -size_t cmap_$_capacity(cmap_$ m); +bool cmap_T_empty(cmap_T m); +size_t cmap_T_size(cmap_T m); +size_t cmap_T_bucket_count(cmap_T m); +size_t cmap_T_capacity(cmap_T m); -void cmap_$_push_n(cmap_$* self, const cmap_$_input_t in[], size_t size); +void cmap_T_push_n(cmap_T* self, const cmap_T_input_t in[], size_t size); -cmap_$_result_t cmap_$_emplace(cmap_$* self, RawKey rawKey RawMapped rawVal); -cmap_$_result_t cmap_$_insert(cmap_$* self, cmap_$_input_t in); -cmap_$_result_t cmap_$_insert_or_assign(cmap_$* self, RawKey rawKey, RawMapped rawVal); -cmap_$_result_t cmap_$_put(cmap_$* self, RawKey rawKey, RawMapped rawVal); -cmap_$_result_t cmap_$_putv(cmap_$* self, RawKey rawKey, Mapped mapped); -cmap_$_mapped_t* cmap_$_at(const cmap_$* self, RawKey rawKey); +cmap_T_result_t cmap_T_emplace(cmap_T* self, RawKey rawKey RawMapped rawVal); +cmap_T_result_t cmap_T_insert(cmap_T* self, cmap_T_input_t in); +cmap_T_result_t cmap_T_insert_or_assign(cmap_T* self, RawKey rawKey, RawMapped rawVal); +cmap_T_result_t cmap_T_put(cmap_T* self, RawKey rawKey, RawMapped rawVal); +cmap_T_result_t cmap_T_putv(cmap_T* self, RawKey rawKey, Mapped mapped); +cmap_T_mapped_t* cmap_T_at(const cmap_T* self, RawKey rawKey); -size_t cmap_$_erase(cmap_$* self, RawKey rawKey) -void cmap_$_erase_entry(cmap_$* self, cmap_$_value_t* val); -cmap_$_iter_t cmap_$_erase_at(cmap_$* self, cmap_$_iter_t pos); +size_t cmap_T_erase(cmap_T* self, RawKey rawKey) +void cmap_T_erase_entry(cmap_T* self, cmap_T_value_t* val); +cmap_T_iter_t cmap_T_erase_at(cmap_T* self, cmap_T_iter_t pos); -cmap_$_value_t* cmap_$_find(const cmap_$* self, RawKey rawKey); -bool cmap_$_contains(const cmap_$* self, RawKey rawKey); +cmap_T_value_t* cmap_T_find(const cmap_T* self, RawKey rawKey); +bool cmap_T_contains(const cmap_T* self, RawKey rawKey); -cmap_$_iter_t cmap_$_begin(cmap_$* self); -cmap_$_iter_t cmap_$_end(cmap_$* self) -void cmap_$_next(cmap_$_iter_t* it); -cmap_$_mapped_t* cmap_$_itval(cmap_$_iter_t it); +cmap_T_iter_t cmap_T_begin(cmap_T* self); +cmap_T_iter_t cmap_T_end(cmap_T* self) +void cmap_T_next(cmap_T_iter_t* it); +cmap_T_mapped_t* cmap_T_itval(cmap_T_iter_t it); -cmap_bucket_t cmap_$_bucket(const cmap_$* self, const cmap_$_rawkey_t* rawKeyPtr); +cmap_bucket_t cmap_T_bucket(const cmap_T* self, const cmap_T_rawkey_t* rawKeyPtr); uint32_t c_default_hash16(const void *data, size_t len); uint32_t c_default_hash32(const void* data, size_t len); |
