From 6f8642f51d1e345ffabba34b598390081475f1c6 Mon Sep 17 00:00:00 2001 From: Tyge Løvset <60263450+tylov@users.noreply.github.com> Date: Thu, 21 Jan 2021 11:54:24 +0100 Subject: Update carray_api.md --- docs/carray_api.md | 6 +++--- 1 file 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 ![Array](pics/array.jpg) -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" -- cgit v1.2.3