summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-11 11:29:57 +0100
committerTyge Løvset <[email protected]>2021-03-11 11:29:57 +0100
commitc077e4b93a8d20c20b2626e2616d116be64247da (patch)
treead64f2bf54877fe2d47c54f0dbb7212277c87a28 /docs/cmap_api.md
parent87ae20d6192380d2da50d439b88f89b6ff64a433 (diff)
downloadSTC-modified-c077e4b93a8d20c20b2626e2616d116be64247da.tar.gz
STC-modified-c077e4b93a8d20c20b2626e2616d116be64247da.zip
Renamed public *_result_t struct member names in maps/sets for consistency with iterators.
Diffstat (limited to 'docs/cmap_api.md')
-rw-r--r--docs/cmap_api.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index ce5b310d..e4aa886f 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -73,6 +73,7 @@ cmap_X_mapped_t* cmap_X_at(const cmap_X* self, RawKey rkey);
size_t cmap_X_erase(cmap_X* self, RawKey rkey);
cmap_X_iter_t cmap_X_erase_at(cmap_X* self, cmap_X_iter_t pos);
+void cmap_X_erase_entry(cmap_X* self, cmap_X_value_t* entry);
cmap_X_iter_t cmap_X_begin(const cmap_X* self);
cmap_X_iter_t cmap_X_end(const cmap_X* self);
@@ -104,7 +105,7 @@ void c_trivial_del(Type* val); // doe
| `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 + RawMapped type |
-| `cmap_X_result_t` | `struct { cmap_X_value_t *first; bool second; }`| Result of insert/put/emplace |
+| `cmap_X_result_t` | `struct { cmap_X_value_t *ref; bool inserted; }`| Result of insert/put/emplace |
| `cmap_X_iter_t` | `struct { cmap_X_value_t *ref; ... }` | Iterator type |
## Constants and macros
@@ -313,7 +314,7 @@ int main()
cmap_vk_value_t *e = cmap_vk_find(&vikings, lookup).ref;
e->second += 3; // add 3 hp points to Einar
- cmap_vk_emplace(&vikings, lookup, 0).first->second += 5; // add 5 more to Einar
+ cmap_vk_emplace(&vikings, lookup, 0).ref->second += 5; // add 5 more to Einar
c_foreach (k, cmap_vk, vikings) {
printf("%s of %s has %d hp\n", k.ref->first.name.str, k.ref->first.country.str, k.ref->second);