diff options
| -rw-r--r-- | docs/carray_api.md | 20 | ||||
| -rw-r--r-- | docs/cdeq_api.md | 16 | ||||
| -rw-r--r-- | docs/clist_api.md | 6 | ||||
| -rw-r--r-- | docs/csptr_api.md | 8 | ||||
| -rw-r--r-- | docs/cvec_api.md | 18 |
5 files changed, 34 insertions, 34 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md index f74ee157..5a86240f 100644 --- a/docs/carray_api.md +++ b/docs/carray_api.md @@ -23,16 +23,16 @@ See the c++ class [boost::multi_array](https://www.boost.org/doc/libs/release/li carr2_X: ```c carr2_X carr2_X_init(size_t xdim, size_t ydim); -carr2_X carr2_X_with_values(size_t xdim, size_t ydim, Value val); -carr2_X carr2_X_with_storage(size_t xdim, size_t ydim, Value* array); +carr2_X carr2_X_with_values(size_t xdim, size_t ydim, i_val val); +carr2_X carr2_X_with_storage(size_t xdim, size_t ydim, i_val* array); carr2_X carr2_X_clone(carr2_X arr); void carr2_X_copy(carr2_X* self, carr2_X other); -Value* carr2_X_release(carr2_X* self); // release storage (not freed) +i_val* carr2_X_release(carr2_X* self); // release storage (not freed) void carr2_X_del(carr2_X* self); size_t carr2_X_size(carr2_X arr); -Value* carr2_X_data(carr2_X* self); // access storage data -Value* carr2_X_at(carr2_X* self, size_t x, size_t y); +i_val* carr2_X_data(carr2_X* self); // access storage data +i_val* carr2_X_at(carr2_X* self, size_t x, size_t y); carr2_X_iter_t carr2_X_begin(const carr2_X* self); carr2_X_iter_t carr2_X_end(const carr2_X* self); @@ -41,16 +41,16 @@ void carr2_X_next(carr2_X_iter_t* it); carr3: ```c carr3_X carr3_X_init(size_t xdim, size_t ydim, size_t zdim); -carr3_X carr3_X_with_values(size_t xdim, size_t ydim, size_t zdim, Value val); -carr3_X carr3_X_with_storage(size_t xdim, size_t ydim, size_t zdim, Value* array); +carr3_X carr3_X_with_values(size_t xdim, size_t ydim, size_t zdim, i_val val); +carr3_X carr3_X_with_storage(size_t xdim, size_t ydim, size_t zdim, i_val* array); carr3_X carr3_X_clone(carr3_X arr); void carr3_X_copy(carr3_X* self, carr3_X other); -Value* carr3_X_release(carr3_X* self); // release storage (not freed) +i_val* carr3_X_release(carr3_X* self); // release storage (not freed) void carr3_X_del(carr3_X* self); size_t carr3_X_size(carr3_X arr); -Value* carr3_X_data(carr3_X* self); // access storage data -Value* carr3_X_at(carr3_X* self, size_t x, size_t y, size_t z); +i_val* carr3_X_data(carr3_X* self); // access storage data +i_val* carr3_X_at(carr3_X* self, size_t x, size_t y, size_t z); carr3_X_iter_t carr3_X_begin(const carr3_X* self); carr3_X_iter_t carr3_X_end(const carr3_X* self); diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md index 486a5758..ea6f176e 100644 --- a/docs/cdeq_api.md +++ b/docs/cdeq_api.md @@ -42,25 +42,25 @@ cdeq_X_value_t* cdeq_X_at(const cdeq_X* self, size_t idx); cdeq_X_value_t* cdeq_X_front(const cdeq_X* self); cdeq_X_value_t* cdeq_X_back(const cdeq_X* self); -void cdeq_X_push_front(cdeq_X* self, Value value); +void cdeq_X_push_front(cdeq_X* self, i_val value); void cdeq_X_emplace_front(cdeq_X* self, i_valraw raw); void cdeq_X_pop_front(cdeq_X* self); -void cdeq_X_push_back(cdeq_X* self, Value value); +void cdeq_X_push_back(cdeq_X* self, i_val value); void cdeq_X_emplace_back(cdeq_X* self, i_valraw raw); void cdeq_X_pop_back(cdeq_X* self); -cdeq_X_iter_t cdeq_X_insert(cdeq_X* self, size_t idx, Value value); // move value -cdeq_X_iter_t cdeq_X_insert_n(cdeq_X* self, size_t idx, const Value[] arr, size_t n); // move arr values -cdeq_X_iter_t cdeq_X_insert_at(cdeq_X* self, cdeq_X_iter_t it, Value value); // move value +cdeq_X_iter_t cdeq_X_insert(cdeq_X* self, size_t idx, i_val value); // move value +cdeq_X_iter_t cdeq_X_insert_n(cdeq_X* self, size_t idx, const i_val[] arr, size_t n); // move arr values +cdeq_X_iter_t cdeq_X_insert_at(cdeq_X* self, cdeq_X_iter_t it, i_val value); // move value cdeq_X_iter_t cdeq_X_emplace(cdeq_X* self, size_t idx, i_valraw raw); cdeq_X_iter_t cdeq_X_emplace_n(cdeq_X* self, size_t idx, const i_valraw[] arr, size_t n); cdeq_X_iter_t cdeq_X_emplace_at(cdeq_X* self, cdeq_X_iter_t it, i_valraw raw); cdeq_X_iter_t cdeq_X_emplace_range(cdeq_X* self, cdeq_X_iter_t it, cdeq_X_iter_t it1, cdeq_X_iter_t it2); // will clone -cdeq_X_iter_t cdeq_X_emplace_range_p(cdeq_X* self, Value* pos, - const Value* p1, const Value* p2); +cdeq_X_iter_t cdeq_X_emplace_range_p(cdeq_X* self, i_val* pos, + const i_val* p1, const i_val* p2); cdeq_X_iter_t cdeq_X_erase(cdeq_X* self, size_t idx); cdeq_X_iter_t cdeq_X_erase_n(cdeq_X* self, size_t idx, size_t n); @@ -73,7 +73,7 @@ cdeq_X_value_t* cdeq_X_get(const cdeq_X* self, i_valraw raw); void cdeq_X_sort(cdeq_X* self); void cdeq_X_sort_range(cdeq_X_iter_t i1, cdeq_X_iter_t i2, - int(*cmp)(const Value*, const Value*)); + int(*cmp)(const i_val*, const i_val*)); cdeq_X_iter_t cdeq_X_begin(const cdeq_X* self); cdeq_X_iter_t cdeq_X_end(const cdeq_X* self); diff --git a/docs/clist_api.md b/docs/clist_api.md index b9cf9d99..d6be8bfc 100644 --- a/docs/clist_api.md +++ b/docs/clist_api.md @@ -50,15 +50,15 @@ size_t clist_X_count(clist_X list); clist_X_value_t* clist_X_front(const clist_X* self); clist_X_value_t* clist_X_back(const clist_X* self); -void clist_X_push_front(clist_X* self, Value value); +void clist_X_push_front(clist_X* self, i_val value); void clist_X_emplace_front(clist_X* self, i_valraw raw); void clist_X_pop_front(clist_X* self); -void clist_X_push_back(clist_X* self, Value value); // note: no pop_back(). +void clist_X_push_back(clist_X* self, i_val value); // note: no pop_back(). void clist_X_emplace_back(clist_X* self, i_valraw raw); void clist_X_emplace_items(clist_X *self, const clist_X_rawvalue_t arr[], size_t n); -clist_X_iter_t clist_X_insert(clist_X* self, clist_X_iter_t it, Value value); // return iter to new elem +clist_X_iter_t clist_X_insert(clist_X* self, clist_X_iter_t it, i_val value); // return iter to new elem clist_X_iter_t clist_X_emplace(clist_X* self, clist_X_iter_t it, i_valraw raw); clist_X_iter_t clist_X_erase_at(clist_X* self, clist_X_iter_t it); // return iter after it diff --git a/docs/csptr_api.md b/docs/csptr_api.md index 8aa04ed7..5c15fae4 100644 --- a/docs/csptr_api.md +++ b/docs/csptr_api.md @@ -33,8 +33,8 @@ The *csptr_X_compare()*, *csptr_X_del()* methods are defined based on the `i_cmp Use *csptr_X_clone(p)* when sharing ownership of the pointed-to object. For shared pointers stored in containers, define `i_val_csptr` to the shared pointers tag instead of a `i_val` macro. See example below. ```c csptr_X csptr_X_init(); // empty constructor -csptr_X csptr_X_make(Value val); // make_shared constructor, like std::make_shared() -csptr_X csptr_X_from(Value* p); // construct from raw pointer +csptr_X csptr_X_make(i_val val); // make_shared constructor, like std::make_shared() +csptr_X csptr_X_from(i_val* p); // construct from raw pointer csptr_X csptr_X_clone(csptr_X ptr); // return ptr with increased use count csptr_X csptr_X_move(csptr_X* self); // transfer ownership to another sptr. void csptr_X_take(csptr_X* self, csptr_X other); // take a new-created or moved csptr @@ -44,8 +44,8 @@ void csptr_X_del(csptr_X* self); // destruct (d long csptr_X_use_count(csptr_X ptr); void csptr_X_reset(csptr_X* self); -void csptr_X_reset_with(csptr_X* self, Value val); // make and assign new csptr with value -void csptr_X_reset_from(csptr_X* self, Value* p); // create csptr from p. +void csptr_X_reset_with(csptr_X* self, i_val val); // make and assign new csptr with value +void csptr_X_reset_from(csptr_X* self, i_val* p); // create csptr from p. int csptr_X_compare(const csptr_X* x, const csptr_X* y); bool csptr_X_equals(const csptr_X* x, const csptr_X* y); diff --git a/docs/cvec_api.md b/docs/cvec_api.md index 9d45dcd8..294d3a59 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -27,7 +27,7 @@ See the c++ class [std::vector](https://en.cppreference.com/w/cpp/container/vect ```c cvec_X cvec_X_init(void); -cvec_X cvec_X_with_size(size_t size, Value fill); +cvec_X cvec_X_with_size(size_t size, i_val fill); cvec_X cvec_X_with_capacity(size_t size); cvec_X cvec_X_clone(cvec_X vec); @@ -35,7 +35,7 @@ void cvec_X_clear(cvec_X* self); void cvec_X_copy(cvec_X* self, cvec_X other); void cvec_X_shrink_to_fit(cvec_X* self); void cvec_X_reserve(cvec_X* self, size_t cap); -void cvec_X_resize(cvec_X* self, size_t size, Value fill); +void cvec_X_resize(cvec_X* self, size_t size, i_val fill); void cvec_X_swap(cvec_X* a, cvec_X* b); void cvec_X_del(cvec_X* self); // destructor @@ -47,21 +47,21 @@ cvec_X_value_t* cvec_X_at(const cvec_X* self, size_t idx); cvec_X_value_t* cvec_X_front(const cvec_X* self); cvec_X_value_t* cvec_X_back(const cvec_X* self); -void cvec_X_push_back(cvec_X* self, Value value); +void cvec_X_push_back(cvec_X* self, i_val value); void cvec_X_emplace_back(cvec_X* self, i_valraw raw); void cvec_X_pop_back(cvec_X* self); -cvec_X_iter_t cvec_X_insert(cvec_X* self, size_t idx, Value value); // move value -cvec_X_iter_t cvec_X_insert_n(cvec_X* self, size_t idx, const Value[] arr, size_t n); // move arr values -cvec_X_iter_t cvec_X_insert_at(cvec_X* self, cvec_X_iter_t it, Value value); // move value +cvec_X_iter_t cvec_X_insert(cvec_X* self, size_t idx, i_val value); // move value +cvec_X_iter_t cvec_X_insert_n(cvec_X* self, size_t idx, const i_val[] arr, size_t n); // move arr values +cvec_X_iter_t cvec_X_insert_at(cvec_X* self, cvec_X_iter_t it, i_val value); // move value cvec_X_iter_t cvec_X_emplace(cvec_X* self, size_t idx, i_valraw raw); cvec_X_iter_t cvec_X_emplace_n(cvec_X* self, size_t idx, const i_valraw[] arr, size_t n); cvec_X_iter_t cvec_X_emplace_at(cvec_X* self, cvec_X_iter_t it, i_valraw raw); cvec_X_iter_t cvec_X_emplace_range(cvec_X* self, cvec_X_iter_t it, cvec_X_iter_t it1, cvec_X_iter_t it2); // will clone -cvec_X_iter_t cvec_X_emplace_range_p(cvec_X* self, Value* pos, - const Value* p1, const Value* p2); +cvec_X_iter_t cvec_X_emplace_range_p(cvec_X* self, i_val* pos, + const i_val* p1, const i_val* p2); cvec_X_iter_t cvec_X_erase(cvec_X* self, size_t idx); cvec_X_iter_t cvec_X_erase_n(cvec_X* self, size_t idx, size_t n); @@ -76,7 +76,7 @@ cvec_X_iter_t cvec_X_bsearch_in(cvec_X_iter_t i1, cvec_X_iter_t i2, i_valr void cvec_X_sort(cvec_X* self); void cvec_X_sort_range(cvec_X_iter_t i1, cvec_X_iter_t i2, - int(*cmp)(const Value*, const Value*)); + int(*cmp)(const i_val*, const i_val*)); cvec_X_iter_t cvec_X_begin(const cvec_X* self); cvec_X_iter_t cvec_X_end(const cvec_X* self); |