From 2ee1e7245c8ba34c8678e7dd55304004413d4de9 Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Thu, 4 Feb 2021 11:20:15 +0100 Subject: Fix docs --- docs/ccommon_api.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md index cb2e9226..5cba094c 100644 --- a/docs/ccommon_api.md +++ b/docs/ccommon_api.md @@ -25,14 +25,24 @@ c_foreach (i, cvec_x, vec) sum += *i.ref; #### c_forrange Declare an iterator and specify a range to iterate with a for loop. Like python's ***range()*** function: -- c_forrange (stop) # for _ in range(stop): -- c_forrange (i, stop) // IterType=size_t # for i in range(stop): -- c_forrange (i, IterType, stop) # for i in range(stop): -- c_forrange (i, IterType, start, stop) # for i in range(start, stop): -- c_forrange (i, IterType, start, stop, step) # for i in range(start, stop, step): -``` + +| Type name | Python equivalent | +|:----------------------------------------------|:------------------------------------| +| `c_forrange (stop)` | `for _ in range(stop):` | +| `c_forrange (i, stop) // Itertype=size_t` | `for i in range(stop):` | +| `c_forrange (i, IterType, stop)` | `for i in range(stop):` | +| `c_forrange (i, IterType, start, stop)` | `for i in range(start, stop):` | +| `c_forrange (i, IterType, start, stop, step)` | `for i in range(start, stop, step)` | + +```c +c_forrange (5) printf("x"); +// xxxxx +c_forrange (i, 5) printf(" %zu"); +// 0 1 2 3 4 c_forrange (i, int, -3, 3) printf(" %d", i); // -3 -2 -1 0 1 2 +c_forrange (i, int, 30, 0, -5) printf(" %d", i); +// 30 25 20 15 10 5 ``` #### c_withbuffer -- cgit v1.2.3