summaryrefslogtreecommitdiffhomepage
path: root/docs/carray_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-17 07:55:59 +0100
committerTyge Løvset <[email protected]>2020-12-17 07:55:59 +0100
commitbc2981ee8fa3cba0be0d0efb1e2a2072c98ca5a0 (patch)
tree2e848e43a77cf4507645d7b89231c9a726b3ec05 /docs/carray_api.md
parent214a2aa75d164d285661719131f54c71fa2f8e37 (diff)
downloadSTC-modified-bc2981ee8fa3cba0be0d0efb1e2a2072c98ca5a0.tar.gz
STC-modified-bc2981ee8fa3cba0be0d0efb1e2a2072c98ca5a0.zip
API change: Reverted back to original name used for .val in iterators to .ref
Diffstat (limited to 'docs/carray_api.md')
-rw-r--r--docs/carray_api.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index 9d80ad13..24841448 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -19,7 +19,7 @@ be replaced by `my` in all of the following documentation. The `#` character sho
|:---------------------|:------------------------------|:--------------------------|
| `carray#X` | `struct { ... }` | The carray type |
| `carray#X_value_t` | `Value` | The value type |
-| `carray#X_iter_t` | `struct { Value *val; }` | Iterator type |
+| `carray#X_iter_t` | `struct { Value *ref; }` | Iterator type |
## Constants and macros
@@ -46,9 +46,9 @@ All cset definitions and prototypes may be included in your C source file by inc
### Constructors
```c
-carray1X carray1X_init(size_t xdim, Value val);
-carray2X carray2X_init(size_t ydim, size_t xdim, Value val);
-carray3X carray3X_init(size_t zdim, size_t ydim, size_t xdim, Value val);
+carray1X carray1X_init(size_t xdim, Value ref);
+carray2X carray2X_init(size_t ydim, size_t xdim, Value ref);
+carray3X carray3X_init(size_t zdim, size_t ydim, size_t xdim, Value ref);
carray1X carray1X_from(Value* array, size_t xdim);
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);