aboutsummaryrefslogtreecommitdiff
path: root/docs/help
diff options
context:
space:
mode:
Diffstat (limited to 'docs/help')
-rw-r--r--docs/help/depth.html7
-rw-r--r--docs/help/leftargument.html12
-rw-r--r--docs/help/length_notequals.html1
-rw-r--r--docs/help/merge_greaterthan.html5
-rw-r--r--docs/help/nothing.html8
-rw-r--r--docs/help/rank.html2
-rw-r--r--docs/help/rank_equals.html1
7 files changed, 27 insertions, 9 deletions
diff --git a/docs/help/depth.html b/docs/help/depth.html
index 03fcaea6..4657a433 100644
--- a/docs/help/depth.html
+++ b/docs/help/depth.html
@@ -7,10 +7,13 @@
<h1 id="circle-with-two-dots-"><a class="header" href="#circle-with-two-dots-">Circle With Two Dots (<code><span class='Modifier2'>โš‡</span></code>)</a></h1>
<h2 id="๐”ฝ๐•˜-๐•ฉ-๐•จ-๐”ฝ๐•˜-๐•ฉ-depth"><a class="header" href="#๐”ฝ๐•˜-๐•ฉ-๐•จ-๐”ฝ๐•˜-๐•ฉ-depth"><code><span class='Function'>๐”ฝ</span><span class='Modifier2'>โš‡</span><span class='Value'>๐•˜</span> <span class='Value'>๐•ฉ</span></code>, <code><span class='Value'>๐•จ</span> <span class='Function'>๐”ฝ</span><span class='Modifier2'>โš‡</span><span class='Value'>๐•˜</span> <span class='Value'>๐•ฉ</span></code>: Depth</a></h2>
<p><a class="fulldoc" href="../doc/depth.html#the-depth-modifier">โ†’full documentation</a></p>
-<p>Apply <code><span class='Function'>๐”ฝ</span></code> to the cells of the arguments at depth given in <code><span class='Value'>๐•˜</span></code>.</p>
-<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=MeKKuOKGk+KahzEg4p+o4p+oMSwyLDPin6ksIOKfqDQsNSw24p+p4p+pCgoxIOKGk+KahzEg4p+o4p+oMSwyLDPin6ksIOKfqDQsNSw24p+p4p+p">โ†—๏ธ</a><pre> <span class='Number'>1</span><span class='Modifier2'>โŠธ</span><span class='Function'>โ†“</span><span class='Modifier2'>โš‡</span><span class='Number'>1</span> <span class='Bracket'>โŸจโŸจ</span><span class='Number'>1</span><span class='Separator'>,</span><span class='Number'>2</span><span class='Separator'>,</span><span class='Number'>3</span><span class='Bracket'>โŸฉ</span><span class='Separator'>,</span> <span class='Bracket'>โŸจ</span><span class='Number'>4</span><span class='Separator'>,</span><span class='Number'>5</span><span class='Separator'>,</span><span class='Number'>6</span><span class='Bracket'>โŸฉโŸฉ</span>
+<p>Apply <code><span class='Function'>๐”ฝ</span></code> to the cells of the arguments at depth given in <code><span class='Value'>๐•˜</span></code>. Negative numbers count down from the top level and non-negative ones from the bottom up.</p>
+<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=MeKKuOKGk+KahzEg4p+o4p+oMSwyLDPin6ksIOKfqDQsNSw24p+p4p+pCgoxIOKGk+KahzEg4p+o4p+oMSwyLDPin6ksIOKfqDQsNSw24p+p4p+pCgooK8K04oaVKeKahzAg4p+oMiw04oC/Nywz4p+pICAjIEltcGxlbWVudHMgcGVydmFzaW9u">โ†—๏ธ</a><pre> <span class='Number'>1</span><span class='Modifier2'>โŠธ</span><span class='Function'>โ†“</span><span class='Modifier2'>โš‡</span><span class='Number'>1</span> <span class='Bracket'>โŸจโŸจ</span><span class='Number'>1</span><span class='Separator'>,</span><span class='Number'>2</span><span class='Separator'>,</span><span class='Number'>3</span><span class='Bracket'>โŸฉ</span><span class='Separator'>,</span> <span class='Bracket'>โŸจ</span><span class='Number'>4</span><span class='Separator'>,</span><span class='Number'>5</span><span class='Separator'>,</span><span class='Number'>6</span><span class='Bracket'>โŸฉโŸฉ</span>
โŸจ โŸจ 2 3 โŸฉ โŸจ 5 6 โŸฉ โŸฉ
<span class='Number'>1</span> <span class='Function'>โ†“</span><span class='Modifier2'>โš‡</span><span class='Number'>1</span> <span class='Bracket'>โŸจโŸจ</span><span class='Number'>1</span><span class='Separator'>,</span><span class='Number'>2</span><span class='Separator'>,</span><span class='Number'>3</span><span class='Bracket'>โŸฉ</span><span class='Separator'>,</span> <span class='Bracket'>โŸจ</span><span class='Number'>4</span><span class='Separator'>,</span><span class='Number'>5</span><span class='Separator'>,</span><span class='Number'>6</span><span class='Bracket'>โŸฉโŸฉ</span>
โŸจ โŸจ 2 3 โŸฉ โŸจ 5 6 โŸฉ โŸฉ
+
+ <span class='Paren'>(</span><span class='Function'>+</span><span class='Modifier'>ยด</span><span class='Function'>โ†•</span><span class='Paren'>)</span><span class='Modifier2'>โš‡</span><span class='Number'>0</span> <span class='Bracket'>โŸจ</span><span class='Number'>2</span><span class='Separator'>,</span><span class='Number'>4</span><span class='Ligature'>โ€ฟ</span><span class='Number'>7</span><span class='Separator'>,</span><span class='Number'>3</span><span class='Bracket'>โŸฉ</span> <span class='Comment'># Implements pervasion
+</span>โŸจ 1 โŸจ 6 21 โŸฉ 3 โŸฉ
</pre>
diff --git a/docs/help/leftargument.html b/docs/help/leftargument.html
index 2c92de98..58c60486 100644
--- a/docs/help/leftargument.html
+++ b/docs/help/leftargument.html
@@ -8,6 +8,16 @@
<h2 id="๐•จ-left-argument"><a class="header" href="#๐•จ-left-argument"><code><span class='Value'>๐•จ</span></code>: Left Argument</a></h2>
<p><a class="fulldoc" href="../doc/syntax.html#blocks">โ†’full documentation</a></p>
<p>A variable assigned to the left argument of a block. <code><span class='Function'>๐•Ž</span></code> can be used to access the left argument as a function.</p>
-<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=NSB78J2VqH0gMQ==">โ†—๏ธ</a><pre> <span class='Number'>5</span> <span class='Brace'>{</span><span class='Value'>๐•จ</span><span class='Brace'>}</span> <span class='Number'>1</span>
+<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=NSB78J2VqH0gMQoKLeKAv8O3IHvwnZWO8J2VqX3CqCA0">โ†—๏ธ</a><pre> <span class='Number'>5</span> <span class='Brace'>{</span><span class='Value'>๐•จ</span><span class='Brace'>}</span> <span class='Number'>1</span>
5
+
+ <span class='Function'>-</span><span class='Ligature'>โ€ฟ</span><span class='Function'>รท</span> <span class='Brace'>{</span><span class='Function'>๐•Ž</span><span class='Value'>๐•ฉ</span><span class='Brace'>}</span><span class='Modifier'>ยจ</span> <span class='Number'>4</span>
+โŸจ ยฏ4 0.25 โŸฉ
+</pre>
+<p>In a call with no left argument, <code><span class='Value'>๐•จ</span></code> functions as <a href="nothing.html">Nothing</a> and <code><span class='Function'>๐•Ž</span></code> can't be used.</p>
+<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=eygt8J2VqCnii4jwnZWpfSA2CgoyIHsoLfCdlagp4ouI8J2VqX0gNg==">โ†—๏ธ</a><pre> <span class='Brace'>{</span><span class='Paren'>(</span><span class='Function'>-</span><span class='Value'>๐•จ</span><span class='Paren'>)</span><span class='Function'>โ‹ˆ</span><span class='Value'>๐•ฉ</span><span class='Brace'>}</span> <span class='Number'>6</span>
+โŸจ 6 โŸฉ
+
+ <span class='Number'>2</span> <span class='Brace'>{</span><span class='Paren'>(</span><span class='Function'>-</span><span class='Value'>๐•จ</span><span class='Paren'>)</span><span class='Function'>โ‹ˆ</span><span class='Value'>๐•ฉ</span><span class='Brace'>}</span> <span class='Number'>6</span>
+โŸจ ยฏ2 6 โŸฉ
</pre>
diff --git a/docs/help/length_notequals.html b/docs/help/length_notequals.html
index 3667e2fe..9efb3a35 100644
--- a/docs/help/length_notequals.html
+++ b/docs/help/length_notequals.html
@@ -25,6 +25,7 @@
</pre>
<h2 id="๐•จ--๐•ฉ-not-equal-to"><a class="header" href="#๐•จ--๐•ฉ-not-equal-to"><code><span class='Value'>๐•จ</span> <span class='Function'>โ‰ </span> <span class='Value'>๐•ฉ</span></code>: Not Equal To</a></h2>
<p><a class="fulldoc" href="../doc/arithmetic.html#comparisons">โ†’full documentation</a></p>
+<p>Do argument atoms not match?</p>
<p><a href="../doc/arithmetic.html#pervasion">Pervasive.</a></p>
<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=MSDiiaAgMwoKMuKAvzPigL8wIOKJoCAz4oC/MeKAvzAKCidhJyDiiaAgJ2En">โ†—๏ธ</a><pre> <span class='Number'>1</span> <span class='Function'>โ‰ </span> <span class='Number'>3</span>
1
diff --git a/docs/help/merge_greaterthan.html b/docs/help/merge_greaterthan.html
index c0b21032..da588aa8 100644
--- a/docs/help/merge_greaterthan.html
+++ b/docs/help/merge_greaterthan.html
@@ -7,9 +7,8 @@
<h1 id="greater-than-"><a class="header" href="#greater-than-">Greater Than (<code><span class='Function'>&gt;</span></code>)</a></h1>
<h2 id="-๐•ฉ-merge"><a class="header" href="#-๐•ฉ-merge"><code><span class='Function'>&gt;</span> <span class='Value'>๐•ฉ</span></code>: Merge</a></h2>
<p><a class="fulldoc" href="../doc/couple.html">โ†’full documentation</a></p>
-<p>Add the rank of an element of <code><span class='Value'>๐•ฉ</span></code> to the rank of <code><span class='Value'>๐•ฉ</span></code>.</p>
-<p>All elements must have the same rank.</p>
-<p>Returns atomic values as is.</p>
+<p>Combine an array of arrays into one array. All elements of <code><span class='Value'>๐•ฉ</span></code> must have the same rank, and the result rank is that plus the rank of <code><span class='Value'>๐•ฉ</span></code>.</p>
+<p>Returns and boxed atoms unchanged.</p>
<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=YSDihpAg4p+o4p+oMSwgMuKfqSwg4p+oMywgNOKfqeKfqQoKPmEKCuKJomEKCuKJoj5h">โ†—๏ธ</a><pre> <span class='Value'>a</span> <span class='Gets'>โ†</span> <span class='Bracket'>โŸจโŸจ</span><span class='Number'>1</span><span class='Separator'>,</span> <span class='Number'>2</span><span class='Bracket'>โŸฉ</span><span class='Separator'>,</span> <span class='Bracket'>โŸจ</span><span class='Number'>3</span><span class='Separator'>,</span> <span class='Number'>4</span><span class='Bracket'>โŸฉโŸฉ</span>
<span class='Function'>&gt;</span><span class='Value'>a</span>
diff --git a/docs/help/nothing.html b/docs/help/nothing.html
index b83a26c4..f4361a83 100644
--- a/docs/help/nothing.html
+++ b/docs/help/nothing.html
@@ -7,6 +7,10 @@
<h1 id="middle-dot-"><a class="header" href="#middle-dot-">Middle Dot (<code><span class='Nothing'>ยท</span></code>)</a></h1>
<h2 id="-nothing"><a class="header" href="#-nothing"><code><span class='Nothing'>ยท</span></code>: Nothing</a></h2>
<p><a class="fulldoc" href="../doc/expression.html#nothing">โ†’full documentation</a></p>
+<p>Indicates no value. If a left argument is Nothing, the function is called with no left argument, and if the right is Nothing, it's not called and &quot;returns&quot; Nothing.</p>
+<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=wrcg4oy9ICJhYmMiICAjIFJldmVyc2UgaW5zdGVhZCBvZiBSb3RhdGU=">โ†—๏ธ</a><pre> <span class='Nothing'>ยท</span> <span class='Function'>โŒฝ</span> <span class='String'>&quot;abc&quot;</span> <span class='Comment'># Reverse instead of Rotate
+</span>"cba"
+</pre>
<h3 id="in-trains"><a class="header" href="#in-trains">In Trains</a></h3>
<p>Nothing can serve as a left argument in a train to string together multiple monadic functions.</p>
<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=KC0rLSkgNQoKKC3CtystKSA1">โ†—๏ธ</a><pre> <span class='Paren'>(</span><span class='Function'>-+-</span><span class='Paren'>)</span> <span class='Number'>5</span>
@@ -15,8 +19,8 @@
<span class='Paren'>(</span><span class='Function'>-</span><span class='Nothing'>ยท</span><span class='Function'>+-</span><span class='Paren'>)</span> <span class='Number'>5</span>
5
</pre>
-<h3 id="in-block-headers"><a class="header" href="#in-block-headers">In Block Headers</a></h3>
-<p>For Block header pattern matching syntax, Nothing can be used to indicate an unused value.</p>
+<h3 id="destructuring"><a class="header" href="#destructuring">Destructuring</a></h3>
+<p>For pattern matching in assignment or a block header, Nothing indicates an unused value.</p>
<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=RiDihpAge/CdlYogYeKAv8K34oC/YjogYeKIvmJ9CgpGIDHigL8y4oC/Mw==">โ†—๏ธ</a><pre> <span class='Function'>F</span> <span class='Gets'>โ†</span> <span class='Brace'>{</span><span class='Function'>๐•Š</span> <span class='Value'>a</span><span class='Ligature'>โ€ฟ</span><span class='Nothing'>ยท</span><span class='Ligature'>โ€ฟ</span><span class='Value'>b</span><span class='Head'>:</span> <span class='Value'>a</span><span class='Function'>โˆพ</span><span class='Value'>b</span><span class='Brace'>}</span>
<span class='Function'>F</span> <span class='Number'>1</span><span class='Ligature'>โ€ฟ</span><span class='Number'>2</span><span class='Ligature'>โ€ฟ</span><span class='Number'>3</span>
diff --git a/docs/help/rank.html b/docs/help/rank.html
index 1789d21f..e296e97a 100644
--- a/docs/help/rank.html
+++ b/docs/help/rank.html
@@ -6,7 +6,7 @@
<div class="nav">(<a href="https://github.com/mlochbaum/BQN">github</a>) / <a href="../index.html">BQN</a> / <a href="index.html">help</a></div>
<h1 id="circled-horizontal-bar-with-notch-"><a class="header" href="#circled-horizontal-bar-with-notch-">Circled Horizontal Bar With Notch (<code><span class='Modifier2'>โމ</span></code>)</a></h1>
<h2 id="๐”ฝ๐•˜-๐•ฉ-๐•จ-๐”ฝ๐•˜-๐•ฉ-rank"><a class="header" href="#๐”ฝ๐•˜-๐•ฉ-๐•จ-๐”ฝ๐•˜-๐•ฉ-rank"><code><span class='Function'>๐”ฝ</span><span class='Modifier2'>โމ</span><span class='Value'>๐•˜</span> <span class='Value'>๐•ฉ</span></code>, <code><span class='Value'>๐•จ</span> <span class='Function'>๐”ฝ</span><span class='Modifier2'>โމ</span><span class='Value'>๐•˜</span> <span class='Value'>๐•ฉ</span></code>: Rank</a></h2>
-<p>Apply <code><span class='Function'>๐”ฝ</span></code> to cells at ranks given in <code><span class='Value'>๐•˜</span></code>.</p>
+<p>Apply <code><span class='Function'>๐”ฝ</span></code> to cells at ranks given in <code><span class='Value'>๐•˜</span></code>. Non-negative numbers indicate the rank of the cell and negative ones indicate the difference from full rank.</p>
<p>The ranks applied are given by the following:</p>
<ul>
<li><code><span class='Modifier2'>โމ</span> <span class='Value'>c</span></code> Rank-c cells of <code><span class='Value'>๐•ฉ</span></code> (monadic) or both arguments (dyadic)</li>
diff --git a/docs/help/rank_equals.html b/docs/help/rank_equals.html
index bd5b3727..65313deb 100644
--- a/docs/help/rank_equals.html
+++ b/docs/help/rank_equals.html
@@ -34,6 +34,7 @@
</pre>
<h2 id="๐•จ--๐•ฉ-equal-to"><a class="header" href="#๐•จ--๐•ฉ-equal-to"><code><span class='Value'>๐•จ</span> <span class='Function'>=</span> <span class='Value'>๐•ฉ</span></code>: Equal To</a></h2>
<p><a class="fulldoc" href="../doc/arithmetic.html#comparisons">โ†’full documentation</a></p>
+<p>Do argument atoms match?</p>
<p><a href="../doc/arithmetic.html#pervasion">Pervasive.</a></p>
<a class="replLink" title="Open in the REPL" target="_blank" href="https://mlochbaum.github.io/BQN/try.html#code=MSA9IDMKCjLigL8z4oC/MCA9IDPigL8x4oC/MAoKJ2EnID0gJ2En">โ†—๏ธ</a><pre> <span class='Number'>1</span> <span class='Function'>=</span> <span class='Number'>3</span>
0