diff options
| -rw-r--r-- | docs/cmap_api.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md index c0fb81d2..a21bd732 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -51,7 +51,7 @@ using_cmap(str, cstr_t, cstr_t, cstr_del, ...) // uses char* as "raw" types | `cmap_X_key_t` | `Key` | The key type | | `cmap_X_mapped_t` | `Mapped` | The mapped type | | `cmap_X_value_t` | `struct { Key first; Mapped second; }` | The value type | -| `cmap_X_rawvalue_t` | `struct { RawKey first; RawMapped second; }` | RawKey + RawVal type | +| `cmap_X_rawvalue_t` | `struct { RawKey first; RawMapped second; }` | RawKey + RawMapped type | | `cmap_X_result_t` | `struct { cmap_X_value_t first; bool second; }` | Result of insert/put/emplace | | `cmap_X_iter_t` | `struct { cmap_X_value_t *ref; ... }` | Iterator type | @@ -85,23 +85,23 @@ void cmap_X_del(cmap_X* self); 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); +size_t cmap_X_bucket_count(cmap_X m); // num. of allocated buckets +size_t cmap_X_capacity(cmap_X m); // buckets * max_load_factor void cmap_X_push_n(cmap_X* self, const cmap_X_rawvalue_t arr[], size_t size); -cmap_X_result_t cmap_X_emplace(cmap_X* self, RawKey rkey, RawMapped rmapped); -cmap_X_result_t cmap_X_insert(cmap_X* self, cmap_X_rawvalue_t rval); +cmap_X_result_t cmap_X_emplace(cmap_X* self, RawKey rkey, RawMapped rmapped); // no change if rkey in map +cmap_X_result_t cmap_X_insert(cmap_X* self, cmap_X_rawvalue_t rval); // same, but takes rawvalue param cmap_X_result_t cmap_X_insert_or_assign(cmap_X* self, RawKey rkey, RawMapped rmapped); -cmap_X_result_t cmap_X_put(cmap_X* self, RawKey rkey, RawMapped rmapped); -cmap_X_result_t cmap_X_put_mapped(cmap_X* self, RawKey rkey, Mapped mapped); -cmap_X_mapped_t* cmap_X_at(const cmap_X* self, RawKey rkey); +cmap_X_result_t cmap_X_put(cmap_X* self, RawKey rkey, RawMapped rmapped); // same as insert_or_assign() +cmap_X_result_t cmap_X_put_mapped(cmap_X* self, RawKey rkey, Mapped mapped); // same, but takes Mapped param +cmap_X_mapped_t* cmap_X_at(const cmap_X* self, RawKey rkey); // rkey must be in map size_t cmap_X_erase(cmap_X* self, RawKey rkey); void cmap_X_erase_entry(cmap_X* self, cmap_X_value_t* entry); cmap_X_iter_t cmap_X_erase_at(cmap_X* self, cmap_X_iter_t pos); -cmap_X_value_t* cmap_X_find(const cmap_X* self, RawKey rkey); +cmap_X_value_t* cmap_X_find(const cmap_X* self, RawKey rkey); // NULL if not found bool cmap_X_contains(const cmap_X* self, RawKey rkey); cmap_X_iter_t cmap_X_begin(cmap_X* self); |