diff options
| -rw-r--r-- | docs/carray_api.md | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md index dfe27066..76151d23 100644 --- a/docs/carray_api.md +++ b/docs/carray_api.md @@ -38,7 +38,7 @@ be replaced by `my` in all of the following documentation. The `N` character sho ## Header file -All cset definitions and prototypes may be included in your C source file by including a single header file. +All carray definitions and prototypes may be included in your C source file by including a single header file. ```c #include "stc/carray.h" @@ -54,7 +54,6 @@ carray2X carray2X_from(Value* array, size_t ydim, size_t xdim); carray3X carray3X_from(Value* array, size_t zdim, size_t ydim, size_t xdim); void carrayNX_del(carrayNX* self); ``` -Constructors and destructor. ```c Value* carray1X_at(carray1X *self, size_t x); Value* carray2X_at(carray2X *self, size_t y, size_t x); @@ -63,14 +62,12 @@ carray1X carray2X_at1(carray2X *self, size_t y); carray1X carray3X_at2(carray3X *self, size_t z, size_t y); carray2X carray3X_at1(carray3X *self, size_t z); ``` -Array accessor methods. ```c carrayNX_iter_t carrayNX_begin(carrayNX* self); carrayNX_iter_t carrayNX_end(carrayNX* self); void carrayNX_next(carrayNX_iter_t* it); carrayNX_value_t* carrayNX_itval(carrayNX_iter_t it); ``` -Iterator methods. ## Example ```c |