summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2023-02-03 22:37:59 +0100
committerTyge Løvset <[email protected]>2023-02-03 22:37:59 +0100
commit2f370b34484e63359f9fd2850b72d3d1d8dfc32a (patch)
tree609fc076aca1f1d218cdbd95379cf795349dce92 /docs
parentcd806510c7c77c0618af58bd804e36f2bad6d219 (diff)
downloadSTC-modified-2f370b34484e63359f9fd2850b72d3d1d8dfc32a.tar.gz
STC-modified-2f370b34484e63359f9fd2850b72d3d1d8dfc32a.zip
Renamed dim to shape in cspan. Not 100% sure it will survive.
Diffstat (limited to 'docs')
-rw-r--r--docs/cspan_api.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/cspan_api.md b/docs/cspan_api.md
index 8321b1e5..66a7b01b 100644
--- a/docs/cspan_api.md
+++ b/docs/cspan_api.md
@@ -58,7 +58,7 @@ void SpanType_next(SpanTypeN_iter* it);
| Type name | Type definition | Used to represent... |
|:------------------|:-----------------------------------------------|:---------------------|
-| SpanTypeN | `struct { ValueType *data; uint32_t dim[N]; }` | SpanType with rank N |
+| SpanTypeN | `struct { ValueType *data; uint32_t shape[N]; }` | SpanType with rank N |
| SpanTypeN`_value` | `ValueType` | The ValueType |
| `c_ALL` | `0,-1` | Full extent |
| `c_END` | `-1` | End of extent |
@@ -100,8 +100,8 @@ int main() {
myspan3 ss3 = cspan_slice(myspan3, &ms3, {c_ALL}, {1,3}, {2,c_END});
myspan2 ss2 = cspan_submd3(&ss3, 1);
- c_FORRANGE (i, ss2.dim[0])
- c_FORRANGE (j, ss2.dim[1])
+ c_FORRANGE (i, ss2.shape[0])
+ c_FORRANGE (j, ss2.shape[1])
fmt_print(" {}", *cspan_at(&ss2, i, j));
puts("");
@@ -163,9 +163,9 @@ int main()
fmt_print("{} ", *i.ref);
puts("\niterate span3 by dimensions:");
- c_FORRANGE (i, span3.dim[0]) {
- c_FORRANGE (j, span3.dim[1]) {
- c_FORRANGE (k, span3.dim[2])
+ c_FORRANGE (i, span3.shape[0]) {
+ c_FORRANGE (j, span3.shape[1]) {
+ c_FORRANGE (k, span3.shape[2])
fmt_printf(" {:2}", *cspan_at(&span3, i, j, k));
printf(" |");
}