Skip to content

Update Coalton documentation #346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stylewarning merged 1 commit into from
Dec 29, 2025
Merged

Update Coalton documentation #346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions content/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3774,7 +3774,7 @@ or do nothing.

### Values

#### <a href="#collect-value"><code>(COLLECT INTO-ITR FA-&gt;M)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L85-L95">src</a></sub></sup><a name="collect-value"></a>
#### <a href="#collect-value"><code>(COLLECT INTO-ITR FA-&gt;M)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L99-L109">src</a></sub></sup><a name="collect-value"></a>
<code>&forall; :A :B :C :D. (<a href="#monad-class">Monad</a> :C) (<a href="#intoiterator-class">IntoIterator</a> :A :B) &rArr; (:A &rarr; (:B &rarr; (:C :D)) &rarr; (:C (<a href="#list-type">List</a> :D)))</code>

Apply FA->M to each element produced by INTO-ITR and run the resulting monadic action.
Expand All @@ -3784,7 +3784,7 @@ Collect the results.

***

#### <a href="#collect-val-value"><code>(COLLECT-VAL M-OPERATION)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L72-L82">src</a></sub></sup><a name="collect-val-value"></a>
#### <a href="#collect-val-value"><code>(COLLECT-VAL M-OPERATION)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L86-L96">src</a></sub></sup><a name="collect-val-value"></a>
<code>&forall; :A :B :C. (<a href="#monad-class">Monad</a> :A) (<a href="#yielder-class">Yielder</a> :B) &rArr; ((:A (:B :C)) &rarr; (:A (<a href="#list-type">List</a> :C)))</code>

Repeatedly run M-OPERATION, collecting each yielded value into a list until
Expand All @@ -3794,7 +3794,7 @@ no value is yielded.

***

#### <a href="#foreach-value"><code>(FOREACH INTO-ITR FA-&gt;M)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L98-L107">src</a></sub></sup><a name="foreach-value"></a>
#### <a href="#foreach-value"><code>(FOREACH INTO-ITR FA-&gt;M)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L112-L121">src</a></sub></sup><a name="foreach-value"></a>
<code>&forall; :A :B :C :D. (<a href="#monad-class">Monad</a> :C) (<a href="#intoiterator-class">IntoIterator</a> :A :B) &rArr; (:A &rarr; (:B &rarr; (:C :D)) &rarr; (:C <a href="#unit-type">Unit</a>))</code>

Apply FA->M to each element produced by INTO-ITR and run the resulting monadic action.
Expand All @@ -3804,7 +3804,17 @@ Discards the return values and returns Unit.

***

#### <a href="#loop-times-value"><code>(LOOP-TIMES N M-OPERATION)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L60-L68">src</a></sub></sup><a name="loop-times-value"></a>
#### <a href="#loop-do-while-value"><code>(LOOP-DO-WHILE M-TERM? BODY)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L62-L71">src</a></sub></sup><a name="loop-do-while-value"></a>
<code>&forall; :A :B :C. (<a href="#monad-class">Monad</a> :A) (<a href="#terminator-class">Terminator</a> :B) &rArr; ((:A :B) &rarr; (:A :C) &rarr; (:A <a href="#unit-type">Unit</a>))</code>

Before each iteration, evaluate M-TERM?. If it indicates completion, stop; otherwise run BODY.
Returns Unit.



***

#### <a href="#loop-times-value"><code>(LOOP-TIMES N M-OPERATION)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L74-L82">src</a></sub></sup><a name="loop-times-value"></a>
<code>&forall; :A :B. <a href="#monad-class">Monad</a> :A &rArr; (<a href="#ufix-type">UFix</a> &rarr; (<a href="#ufix-type">UFix</a> &rarr; (:A :B)) &rarr; (:A <a href="#unit-type">Unit</a>))</code>

Repeat M-OPERATION N times. Passes the current index (starting at 0) to
Expand All @@ -3814,7 +3824,7 @@ M-OPERATION. Returns Unit.

***

#### <a href="#loop-while-value"><code>(LOOP-WHILE M-OPERATION)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L37-L43">src</a></sub></sup><a name="loop-while-value"></a>
#### <a href="#loop-while-value"><code>(LOOP-WHILE M-OPERATION)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L39-L45">src</a></sub></sup><a name="loop-while-value"></a>
<code>&forall; :A :B. (<a href="#monad-class">Monad</a> :A) (<a href="#terminator-class">Terminator</a> :B) &rArr; ((:A :B) &rarr; (:A <a href="#unit-type">Unit</a>))</code>

Repeat M-OPERATION until it returns a terminated value. Returns Unit.
Expand All @@ -3823,7 +3833,7 @@ Repeat M-OPERATION until it returns a terminated value. Returns Unit.

***

#### <a href="#loop-while-valm-value"><code>(LOOP-WHILE-VALM M-OPERATION F)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L46-L57">src</a></sub></sup><a name="loop-while-valm-value"></a>
#### <a href="#loop-while-valm-value"><code>(LOOP-WHILE-VALM M-OPERATION F)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/experimental/do-control-loops.lisp#L48-L59">src</a></sub></sup><a name="loop-while-valm-value"></a>
<code>&forall; :A :B :C :D. (<a href="#monad-class">Monad</a> :A) (<a href="#yielder-class">Yielder</a> :B) &rArr; ((:A (:B :C)) &rarr; (:C &rarr; (:A :D)) &rarr; (:A <a href="#unit-type">Unit</a>))</code>

Repeat M-OPERATION while it yields a value, running the yielded value applied to F.
Expand All @@ -3842,6 +3852,15 @@ Collect the results.



***

#### <a href="#coalton-library-experimental-do-control-loops-do-loop-do-while-macro"><code>DO-LOOP-DO-WHILE (M-TERM? &amp;BODY BODY)</code></a> <sup><sub>[MACRO]</sub></sup><a name="coalton-library-experimental-do-control-loops-do-loop-do-while-macro"></a>

Before each iteration, evaluate M-TERM?. If it indicates completion, stop; otherwise run BODY.
Wraps BODY in a 'do' block. Returns Unit.



***

# Package `COALTON-LIBRARY/EXPERIMENTAL/DO-CONTROL-LOOPS-ADV`<a name="coalton-library/experimental/do-control-loops-adv-package"></a>
Expand Down