diff options
| author | Tyge Løvset <[email protected]> | 2021-11-03 13:27:00 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-11-03 13:27:00 +0100 |
| commit | 85a7ff53750a55fee9a45083abb2f6daa5b19164 (patch) | |
| tree | c440dac5232f3d02ffe38b4dfbcc0a47b7ac1709 /docs/csmap_api.md | |
| parent | 1790465d3dc002beafb91cc52d8aa6319dc67b35 (diff) | |
| download | STC-modified-85a7ff53750a55fee9a45083abb2f6daa5b19164.tar.gz STC-modified-85a7ff53750a55fee9a45083abb2f6daa5b19164.zip | |
Docs text alignments
Diffstat (limited to 'docs/csmap_api.md')
| -rw-r--r-- | docs/csmap_api.md | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/docs/csmap_api.md b/docs/csmap_api.md index 4a99fcc4..3ae7dde2 100644 --- a/docs/csmap_api.md +++ b/docs/csmap_api.md @@ -34,16 +34,16 @@ See the c++ class [std::map](https://en.cppreference.com/w/cpp/container/map) fo ## Methods ```c -csmap_X csmap_X_init(void); -csmap_X csmap_X_clone(csmap_x map); +csmap_X csmap_X_init(void); +csmap_X csmap_X_clone(csmap_x map); -void csmap_X_clear(csmap_X* self); -void csmap_X_copy(csmap_X* self, csmap_X other); -void csmap_X_swap(csmap_X* a, csmap_X* b); -void csmap_X_del(csmap_X* self); // destructor +void csmap_X_clear(csmap_X* self); +void csmap_X_copy(csmap_X* self, csmap_X other); +void csmap_X_swap(csmap_X* a, csmap_X* b); +void csmap_X_del(csmap_X* self); // destructor -size_t csmap_X_size(csmap_X map); -bool csmap_X_empty(csmap_X map); +size_t csmap_X_size(csmap_X map); +bool csmap_X_empty(csmap_X 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 @@ -53,27 +53,27 @@ csmap_X_iter csmap_X_find(const csmap_X* self, i_keyraw rkey); csmap_X_value* csmap_X_find_it(const csmap_X* self, i_keyraw rkey, csmap_X_iter* out); // return NULL if not found csmap_X_iter csmap_X_lower_bound(const csmap_X* self, i_keyraw rkey); // find closest entry >= rkey -csmap_X_value* csmap_X_front(const csmap_X* self); -csmap_X_value* csmap_X_back(const csmap_X* self); +csmap_X_value* csmap_X_front(const csmap_X* self); +csmap_X_value* csmap_X_back(const csmap_X* self); -csmap_X_result csmap_X_insert(csmap_X* self, i_key key, i_val mapped); // no change if key in map -csmap_X_result csmap_X_insert_or_assign(csmap_X* self, i_key key, i_val mapped); // always update mapped -csmap_X_result csmap_X_put(csmap_X* self, i_key key, i_val mapped); // same as insert_or_assign() +csmap_X_result csmap_X_insert(csmap_X* self, i_key key, i_val mapped); // no change if key in map +csmap_X_result csmap_X_insert_or_assign(csmap_X* self, i_key key, i_val mapped); // always update mapped +csmap_X_result csmap_X_put(csmap_X* self, i_key key, i_val mapped); // same as insert_or_assign() -csmap_X_result csmap_X_emplace(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // no change if rkey in map -csmap_X_result csmap_X_emplace_or_assign(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // always update rmapped +csmap_X_result csmap_X_emplace(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // no change if rkey in map +csmap_X_result csmap_X_emplace_or_assign(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // always update rmapped -size_t csmap_X_erase(csmap_X* self, i_keyraw rkey); -csmap_X_iter csmap_X_erase_at(csmap_X* self, csmap_X_iter it); // returns iter after it -csmap_X_iter csmap_X_erase_range(csmap_X* self, csmap_X_iter it1, csmap_X_iter it2); // returns updated it2 +size_t csmap_X_erase(csmap_X* self, i_keyraw rkey); +csmap_X_iter csmap_X_erase_at(csmap_X* self, csmap_X_iter it); // returns iter after it +csmap_X_iter csmap_X_erase_range(csmap_X* self, csmap_X_iter it1, csmap_X_iter it2); // returns updated it2 -csmap_X_iter csmap_X_begin(const csmap_X* self); -csmap_X_iter csmap_X_end(const csmap_X* self); -void csmap_X_next(csmap_X_iter* iter); -csmap_X_iter csmap_X_advance(csmap_X_iter it, size_t n); +csmap_X_iter csmap_X_begin(const csmap_X* self); +csmap_X_iter csmap_X_end(const csmap_X* self); +void csmap_X_next(csmap_X_iter* iter); +csmap_X_iter csmap_X_advance(csmap_X_iter it, size_t n); -csmap_X_value csmap_X_value_clone(csmap_X_value val); -csmap_X_rawvalue csmap_X_value_toraw(csmap_X_value* pval); +csmap_X_value csmap_X_value_clone(csmap_X_value val); +csmap_X_rawvalue csmap_X_value_toraw(csmap_X_value* pval); ``` ## Types |
