summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-24 08:28:53 +0100
committerTyge Løvset <[email protected]>2021-03-24 08:47:40 +0100
commitc96dc0a43037dd14cd0e2539c988a343d99cc728 (patch)
tree680c3dbdcda63a323c6a140e4e27703d4bb5a00d /docs
parentc92f6f604dbb08530a8931bd6ce2db56d177130d (diff)
downloadSTC-modified-c96dc0a43037dd14cd0e2539c988a343d99cc728.tar.gz
STC-modified-c96dc0a43037dd14cd0e2539c988a343d99cc728.zip
Added alternative at() methods to carrays.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index afa9d62f..1f42deb6 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -38,6 +38,7 @@ void carray2X_del(carray2X* self);
size_t carray2X_size(carray2X arr);
Value* carray2X_data(carray2X* self); // contiguous memory
+Value* carray2X_at(carray2X* self, size_t x, size_t y);
carray2X_iter_t carray2X_begin(const carray2X* self);
carray2X_iter_t carray2X_end(const carray2X* self);
@@ -52,6 +53,7 @@ void carray3X_del(carray3X* self);
size_t carray3X_size(carray3X arr);
Value* carray3X_data(carray3X* self); // contiguous memory
+Value* carray3X_at(carray3X* self, size_t x, size_t y, size_t z);
carray3X_iter_t carray3X_begin(const carray3X* self);
carray3X_iter_t carray3X_end(const carray3X* self);
@@ -68,6 +70,8 @@ void carray3X_next(carray3X_iter_t* it);
| `carray3X_value_t` | `Value` | The value type |
| `carray3X_iter_t` | `struct { Value *ref; }` | Iterator type |
+The **carray** elements can be accessed like `carray3i arr = ...; int val = arr.at[x][y][z];`, or with `carray3i_at(&arr, x, y, z)`.
+
## Example
```c
#include "stc/carray.h"