diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ccommon_api.md | 1 | ||||
| -rw-r--r-- | docs/cspan_api.md | 6 |
2 files changed, 4 insertions, 3 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md index 52ad88e4..6bce56af 100644 --- a/docs/ccommon_api.md +++ b/docs/ccommon_api.md @@ -436,6 +436,7 @@ The **checkauto** utility described below, ensures that the `c_auto*` macros are #include <stc/algo/raii.h> // or <stc/calgo.h> ... // `c_defer` executes the expression(s) when leaving scope. +// Note: does not require inclusion of "raii.h". cstr s1 = cstr_lit("Hello"), s2 = cstr_lit("world"); c_defer (cstr_drop(&s1), cstr_drop(&s2)) { diff --git a/docs/cspan_api.md b/docs/cspan_api.md index 1aeeb4f7..1d3177da 100644 --- a/docs/cspan_api.md +++ b/docs/cspan_api.md @@ -47,12 +47,12 @@ SpanTypeN_iter SpanType_begin(const SpanTypeN* self); SpanTypeN_iter SpanType_end(const SpanTypeN* self); void SpanType_next(SpanTypeN_iter* it); -SpanTypeN cspan_md(ValueType* data, d1, d2, ...); // make a multi-dim cspan, row-major order. -SpanTypeN cspan_md_left(ValueType* data, d1, d2, ...); // column-major ordered cspan (layout left). -SpanTypeN cspan_md_ordered(char order, ValueType* data, d1, d2, ...); // order='C': row-major, 'F' (Fortran): column-major. +SpanTypeN cspan_md(ValueType* data, d1, d2, ...); // make a multi-dim cspan, row-major order. +SpanTypeN cspan_md_order(char order, ValueType* data, d1, d2, ...); // order='C': row-major, 'F': column-major (FORTRAN). // transpose a md span (inverse axes). no changes to the underlying array. void cspan_transpose(const SpanTypeN* self); +bool cspan_is_order_F(const SpanTypeN* self); // create a sub md span of lower rank. Like e.g. cspan_slice(Span2, &ms4, {x}, {y}, {c_ALL}, {c_ALL}); OutSpan1 cspan_submd2(TYPE OutSpan1, const SpanType2* parent, intptr_t x); // return a 1d subspan from a 2d span. |