diff options
| author | Tyge Løvset <[email protected]> | 2021-12-20 19:52:51 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-12-20 19:52:51 +0100 |
| commit | e38e9164d816bf1ee1f1dcc40f69ac158562fb1a (patch) | |
| tree | 23bbec187b488730964ab538d401ded9ab319169 /docs | |
| parent | 0c3d711c2541aebe9a44fecb732e096bed14f72c (diff) | |
| download | STC-modified-e38e9164d816bf1ee1f1dcc40f69ac158562fb1a.tar.gz STC-modified-e38e9164d816bf1ee1f1dcc40f69ac158562fb1a.zip | |
Some small addition to constness in API. Updated docs.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cmap_api.md | 4 | ||||
| -rw-r--r-- | docs/csmap_api.md | 2 | ||||
| -rw-r--r-- | docs/cvec_api.md | 6 |
3 files changed, 7 insertions, 5 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md index 4bb367f8..8531eb82 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -391,8 +391,8 @@ int main() }); Vikings_emplace_or_assign(&vikings, (RViking){"Bjorn", "Sweden"}, 10); - Vikings_value *einar = Vikings_find(&vikings, (RViking){"Einar", "Norway"}).ref; - if (einar) einar->second += 3; // add 3 hp points to Einar + Vikings_value *v = Vikings_get_mut(&vikings, (RViking){"Einar", "Norway"}); + if (v) v->second += 3; // add 3 hp points to Einar c_forpair (viking, health, Vikings, vikings) { printf("%s of %s has %d hp\n", _.viking.name.str, _.viking.country.str, _.health); diff --git a/docs/csmap_api.md b/docs/csmap_api.md index c4f0ff16..a6e06b54 100644 --- a/docs/csmap_api.md +++ b/docs/csmap_api.md @@ -45,7 +45,7 @@ void csmap_X_drop(csmap_X* self); size_t csmap_X_size(csmap_X map); bool csmap_X_empty(csmap_X map); -csmap_X_mapped* csmap_X_at(const csmap_X* self, i_keyraw rkey); // rkey must be in map. +const csmap_X_mapped* csmap_X_at(const csmap_X* self, i_keyraw rkey); // rkey must be in map. const csmap_X_value* csmap_X_get(const csmap_X* self, i_keyraw rkey); // return NULL if not found csmap_X_value* csmap_X_get_mut(csmap_X* self, i_keyraw rkey); // mutable get bool csmap_X_contains(const csmap_X* self, i_keyraw rkey); diff --git a/docs/cvec_api.md b/docs/cvec_api.md index b9d4d2d5..29a3efcb 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -56,15 +56,17 @@ cvec_X_iter cvec_X_bsearch_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw r cvec_X_value* cvec_X_front(const cvec_X* self); cvec_X_value* cvec_X_back(const cvec_X* self); -cvec_X_value* cvec_X_push_back(cvec_X* self, i_val value); cvec_X_value* cvec_X_emplace_back(cvec_X* self, i_valraw raw); +cvec_X_value* cvec_X_push_back(cvec_X* self, i_val value); void cvec_X_pop_back(cvec_X* self); +cvec_X_value* cvec_X_emplace(cvec_X* self, i_valraw raw); // alias for emplace_back +cvec_X_value* cvec_X_push(cvec_X* self, i_val value); // alias for push_back +void cvec_X_pop(cvec_X* self); // alias for pop_back cvec_X_iter cvec_X_insert(cvec_X* self, size_t idx, i_val value); // move value cvec_X_iter cvec_X_insert_n(cvec_X* self, size_t idx, const i_val[] arr, size_t n); // move arr values cvec_X_iter cvec_X_insert_at(cvec_X* self, cvec_X_iter it, i_val value); // move value -cvec_X_iter cvec_X_emplace(cvec_X* self, size_t idx, i_valraw raw); cvec_X_iter cvec_X_emplace_n(cvec_X* self, size_t idx, const i_valraw[] arr, size_t n); cvec_X_iter cvec_X_emplace_at(cvec_X* self, cvec_X_iter it, i_valraw raw); cvec_X_iter cvec_X_emplace_range(cvec_X* self, cvec_X_iter it, |
