summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-31 15:52:17 +0100
committerGitHub <[email protected]>2020-12-31 15:52:17 +0100
commitec88c25a5f78e46fc99b43536d678845bb0d2dbe (patch)
tree8fd98ac53b0983a7b01323a77aeb7b60efc94e64 /docs
parent728cece1c43a494729e21818fdaa321af29788d2 (diff)
downloadSTC-modified-ec88c25a5f78e46fc99b43536d678845bb0d2dbe.tar.gz
STC-modified-ec88c25a5f78e46fc99b43536d678845bb0d2dbe.zip
Update carray_api.md
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md5
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