summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-01 08:04:01 +0100
committerTyge Løvset <[email protected]>2020-12-01 08:04:01 +0100
commit200a539df68c321eb8678cc1d35a75832c2b738b (patch)
tree614c03e622ecec868d6dec5fd2e1cd6c0c170cfb /docs/cmap_api.md
parent8488839e40a85e9c13bbcc6eaf6fba5564b3d678 (diff)
downloadSTC-modified-200a539df68c321eb8678cc1d35a75832c2b738b.tar.gz
STC-modified-200a539df68c321eb8678cc1d35a75832c2b738b.zip
Small fixes, and changed tag parameter name to X.
Diffstat (limited to 'docs/cmap_api.md')
-rw-r--r--docs/cmap_api.md94
1 files changed, 47 insertions, 47 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 05d59da8..3062bc07 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -11,14 +11,14 @@ This describes the API of the unordered map type **cmap**.
#define using_cmap_strkey(Mapped, mappedDestroy=c_default_del)
-#define using_cmap_strval(T, Key, keyEquals=c_default_equals,
+#define using_cmap_strval(X, 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(T, Key, Mapped, mappedDestroy=c_default_del,
+#define using_cmap(X, 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 the unordered map 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. `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
+Default values are given above for args not specified. `X` is a type tag name and
+will affect the names of all cmap types and methods. E.g. declaring `using_cmap(my, int);`, `X` 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,25 +39,25 @@ be replaced by `my` in all of the following documentation.
| Type name | Type definition | Used to represent... |
|:---------------------|:--------------------------------------|:-----------------------------------|
-| `cmap_T` | `struct {` | The cmap type |
-| | ` cmap_T_value_t* table; | |
+| `cmap_X` | `struct {` | The cmap type |
+| | ` cmap_X_value_t* table;` | |
| | ` uint8_t* _hashx;` | |
| | ` ...;` | |
| | `}` | |
-| `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_X_key_t` | `Key` | The cmap key type |
+| `cmap_X_mapped_t` | `Mapped` | cmap mapped type |
+| `cmap_X_value_t` | `struct {` | The cmap value type |
+| | ` cmap_X_key_t first;` | |
+| | ` cmap_X_mapped_t second;` | |
| | `}` | |
-| `cmap_T_input_t` | `cmap_T_value_t` | cmap input type |
-| `cmap_T_rawvalue_t` | `RawMapped` | cmap raw value type |
-| `cmap_T_result_t` | `struct {` | Result of insert/put/emplace |
-| | ` cmap_T_value_t* first;` | |
-| | ` bool second;` /* inserted */ | |
+| `cmap_X_input_t` | `cmap_X_value_t` | cmap input type |
+| `cmap_X_rawvalue_t` | `RawMapped` | cmap raw value type |
+| `cmap_X_result_t` | `struct {` | Result of insert/put/emplace |
+| | ` cmap_X_value_t* first;` | |
+| | ` bool second; /* inserted */` | |
| | `}` | |
-| `cmap_T_iter_t` | `struct {` | cmap iterator |
-| | ` cmap_T_value_t* val;` | |
+| `cmap_X_iter_t` | `struct {` | cmap iterator |
+| | ` cmap_X_value_t* val;` | |
| | ` ...;` | |
| | `}` | |
@@ -83,45 +83,45 @@ All cmap definitions and prototypes may be included in your C source file by inc
### Construction
-The interface for cmap_T:
+The interface for cmap_X:
```c
-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);
+cmap_X cmap_X_init(void);
+cmap_X cmap_X_with_capacity(size_t cap);
+void cmap_X_set_load_factors(cmap_X* self, float max, float shrink);
-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_X_clear(cmap_X* self);
+void cmap_X_reserve(cmap_X* self, size_t size);
+void cmap_X_swap(cmap_X* a, cmap_X* b);
-void cmap_T_del(cmap_T* self);
+void cmap_X_del(cmap_X* self);
-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);
+bool cmap_X_empty(cmap_X m);
+size_t cmap_X_size(cmap_X m);
+size_t cmap_X_bucket_count(cmap_X m);
+size_t cmap_X_capacity(cmap_X m);
-void cmap_T_push_n(cmap_T* self, const cmap_T_input_t in[], size_t size);
+void cmap_X_push_n(cmap_X* self, const cmap_X_input_t in[], size_t size);
-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);
+cmap_X_result_t cmap_X_emplace(cmap_X* self, RawKey rawKey, RawMapped rawVal);
+cmap_X_result_t cmap_X_insert(cmap_X* self, cmap_X_input_t in);
+cmap_X_result_t cmap_X_insert_or_assign(cmap_X* self, RawKey rawKey, RawMapped rawVal);
+cmap_X_result_t cmap_X_put(cmap_X* self, RawKey rawKey, RawMapped rawVal);
+cmap_X_result_t cmap_X_putv(cmap_X* self, RawKey rawKey, Mapped mapped);
+cmap_X_mapped_t* cmap_X_at(const cmap_X* self, RawKey rawKey);
-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);
+size_t cmap_X_erase(cmap_X* self, RawKey rawKey);
+void cmap_X_erase_entry(cmap_X* self, cmap_X_value_t* val);
+cmap_X_iter_t cmap_X_erase_at(cmap_X* self, cmap_X_iter_t pos);
-cmap_T_value_t* cmap_T_find(const cmap_T* self, RawKey rawKey);
-bool cmap_T_contains(const cmap_T* self, RawKey rawKey);
+cmap_X_value_t* cmap_X_find(const cmap_X* self, RawKey rawKey);
+bool cmap_X_contains(const cmap_X* self, RawKey rawKey);
-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_X_iter_t cmap_X_begin(cmap_X* self);
+cmap_X_iter_t cmap_X_end(cmap_X* self);
+void cmap_X_next(cmap_X_iter_t* it);
+cmap_X_mapped_t* cmap_X_itval(cmap_X_iter_t it);
-cmap_bucket_t cmap_T_bucket(const cmap_T* self, const cmap_T_rawkey_t* rawKeyPtr);
+cmap_bucket_t cmap_X_bucket(const cmap_X* self, const cmap_X_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);