diff options
| author | Tyge Løvset <[email protected]> | 2023-02-15 15:40:08 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2023-02-15 15:40:08 +0100 |
| commit | 290055ad96c22fd9dfb539d0217e45cd2f1cdb91 (patch) | |
| tree | ce6d1398ca4a08ddcb42653ad46c0ab76655ee47 /docs/csmap_api.md | |
| parent | e456085a392d063df1a2495422523a2474ea6a18 (diff) | |
| download | STC-modified-290055ad96c22fd9dfb539d0217e45cd2f1cdb91.tar.gz STC-modified-290055ad96c22fd9dfb539d0217e45cd2f1cdb91.zip | |
Cleaned up in size-types. API always uses intptr_t as default for all containers.
Diffstat (limited to 'docs/csmap_api.md')
| -rw-r--r-- | docs/csmap_api.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/csmap_api.md b/docs/csmap_api.md index 19a654d6..89948369 100644 --- a/docs/csmap_api.md +++ b/docs/csmap_api.md @@ -34,7 +34,7 @@ See the c++ class [std::map](https://en.cppreference.com/w/cpp/container/map) fo #define i_tag // alternative typename: csmap_{i_tag}. i_tag defaults to i_val #define i_cmp_functor // advanced, see examples/functor.c for similar usage. -#define i_ssize // defaults to int32_t +#define i_ssize // internal size rep. defaults to int32_t #include <stc/csmap.h> ``` `X` should be replaced by the value of `i_tag` in all of the following documentation. @@ -43,8 +43,8 @@ See the c++ class [std::map](https://en.cppreference.com/w/cpp/container/map) fo ```c csmap_X csmap_X_init(void); -csset_X csmap_X_with_capacity(i_ssize cap); -bool csmap_X_reserve(csmap_X* self, i_ssize cap); +csset_X csmap_X_with_capacity(intptr_t cap); +bool csmap_X_reserve(csmap_X* self, intptr_t cap); void csmap_X_shrink_to_fit(csmap_X* self); csmap_X csmap_X_clone(csmap_x map); @@ -53,8 +53,8 @@ void csmap_X_copy(csmap_X* self, const csmap_X* other); void csmap_X_drop(csmap_X* self); // destructor bool csmap_X_empty(const csmap_X* self); -i_ssize csmap_X_size(const csmap_X* self); -i_ssize csmap_X_capacity(const csmap_X* self); +intptr_t csmap_X_size(const csmap_X* self); +intptr_t csmap_X_capacity(const csmap_X* self); const csmap_X_mapped* csmap_X_at(const csmap_X* self, i_keyraw rkey); // rkey must be in map csmap_X_mapped* csmap_X_at_mut(csmap_X* self, i_keyraw rkey); // mutable at @@ -74,6 +74,7 @@ csmap_X_result csmap_X_push(csmap_X* self, csmap_X_value entry); 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_put(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // csmap_X_emplace_or_assign() alias int 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 @@ -82,7 +83,7 @@ csmap_X_iter csmap_X_erase_range(csmap_X* self, csmap_X_iter it1, csmap 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, i_ssize n); +csmap_X_iter csmap_X_advance(csmap_X_iter it, intptr_t n); csmap_X_value csmap_X_value_clone(csmap_X_value val); csmap_X_raw csmap_X_value_toraw(csmap_X_value* pval); |
