diff options
| author | Tyge Løvset <[email protected]> | 2021-01-21 11:54:24 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-01-21 11:54:24 +0100 |
| commit | 6f8642f51d1e345ffabba34b598390081475f1c6 (patch) | |
| tree | 4b6011458574377a5cd1b0ce7df22509366bbfa0 | |
| parent | 0df5b36fcff8f22d5e6965a461d1d92409606f0a (diff) | |
| download | STC-modified-6f8642f51d1e345ffabba34b598390081475f1c6.tar.gz STC-modified-6f8642f51d1e345ffabba34b598390081475f1c6.zip | |
Update carray_api.md
| -rw-r--r-- | docs/carray_api.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md index 920e1623..77f77e66 100644 --- a/docs/carray_api.md +++ b/docs/carray_api.md @@ -1,8 +1,8 @@ # STC [carray](../stc/carray.h): Dynamic 1/2/3 Dimensional Array  -This is 1D, 2D and 3D arrays, which are allocated from heap in one single contiguous block of memory. -*carray3* may have sub-array "views" of *carray2* and *carray1* etc. +The **carray** containers provides templates for multidimensional arrays of contiguous data It supports 1-, 2- and +3-dimensional arrays, which are allocated from the heap as a single contiguous block of memory. See the c++ class [boost::multi_array](https://www.boost.org/doc/libs/release/libs/multi_array) for similar functionality. @@ -19,7 +19,7 @@ be replaced by `my` in all of the following documentation. The `N` character sho ## Header file -All carray 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" |