diff options
| -rw-r--r-- | docs/spec/primitive.html | 2 | ||||
| -rw-r--r-- | spec/primitive.md | 4 |
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/spec/primitive.html b/docs/spec/primitive.html index ab11aa76..c8db181e 100644 --- a/docs/spec/primitive.html +++ b/docs/spec/primitive.html @@ -117,3 +117,5 @@ <p><strong>Enclose</strong> (<code><span class='Function'><</span></code>) forms a unit array that contains its argument.</p> <p><strong>Merge</strong> (<code><span class='Function'>></span></code>) combines the outer axes of an array of arrays with inner axes: it requires that all elements of its argument have the same shape, and creates an array such that <code><span class='Paren'>(</span><span class='Value'>i</span><span class='Function'>ā¾</span><span class='Value'>j</span><span class='Paren'>)</span><span class='Function'>ā></span><span class='Value'>š©</span></code> is <code><span class='Value'>i</span><span class='Function'>ā</span><span class='Value'>j</span><span class='Function'>ā</span><span class='Value'>š©</span></code>. It also accepts atom elements of <code><span class='Value'>š©</span></code>, converting them to unit arrays, or an atom argument, which is returned unchanged. <strong>Solo</strong> and <strong>Couple</strong> (<code><span class='Function'>ā</span></code>) turn one or two arguments into major cells of the result and can be defined easily in terms of Merge.</p> <p><strong>Join To</strong> (<code><span class='Function'>ā¾</span></code>) combines its two arguments along an existing initial axis, unless both arguments are units, in which case it creates an axis and is identical to Couple (<code><span class='Function'>ā</span></code>). The arguments must differ in rank by at most 1, and the result rank is equal to the maximum of 1 and the higher argument rank. Each argument with rank less than the result, and each major cell of an argument with rank equal to it, becomes a major cell of the result, with cells from the left argument placed before those from the right. <strong>Join</strong> (<code><span class='Function'>ā¾</span></code>) generalizes the equal-rank subset of this behavior to an array of values instead of just two. The argument must be an array (unlike Merge), and its elements must all the same rank, which is at least the argument rank. Atom elements are treated as unit arrays. Then "outer" argument axes are matched up with leading "inner" element axes, and elements are joined along these axes. In order to allow this, the length of an element along a particular axis must depend only on the position along the corresponding axis in the argument. An empty argument to Join is return unchanged, as though the element rank is equal to the argument rank.</p> +<p><strong>Deshape</strong> (<code><span class='Function'>ā„</span></code>) differs from the provided function (which returns the element list of an array) only in that it accepts an atom, returning a one-element list containing it. <strong>Reshape</strong> (<code><span class='Function'>ā„</span></code>) is extended in numerous ways. It accepts any list of natural numbers (including as a unit array or atom) for the left argument and any right argument; <code><span class='Value'>š©</span></code> is deshaped first so that it is treated as a list of elements. These elements are repeated cyclically to fill the result array in ravel order. If <code><span class='Value'>š©</span></code> is empty but the result is not, then the result consists of fill elements for <code><span class='Value'>š©</span></code>. Furthermore, at most one element of <code><span class='Value'>šØ</span></code> can be a "length code": one of the primitives <code><span class='Modifier2'>ā</span><span class='Function'>āā½ā</span></code>. In this case, a target length is computed from the number of elements in <code><span class='Value'>š©</span></code> divided by the product of the other elements of <code><span class='Value'>šØ</span></code> (which must not be zero). If the target length is an integer then it is used directly for the length code. Otherwise, an error is given if the length code is <code><span class='Modifier2'>ā</span></code>, and the target length is rounded down if the code is <code><span class='Function'>ā</span></code> and up if it's <code><span class='Function'>ā½</span></code> or <code><span class='Function'>ā</span></code>. With code <code><span class='Function'>ā½</span></code>, elements are repeated cyclically as usual, but with code <code><span class='Function'>ā</span></code>, the extra elements after each argument element is used are fill values for <code><span class='Value'>š©</span></code>.</p> +<p><strong>Transpose</strong> (<code><span class='Function'>ā</span></code>) reorders axes of its argument to place the first axis last; if the argument has one or fewer axes then it's returned unchanged. <strong>Reorder Axes</strong> (<code><span class='Function'>ā</span></code>) requires the left argument to be a list or unit of natural numbers, with length at most the rank of the right argument. This list is extended to match the right argument rank exactly by repeatedly appending the least unused natural number (for example, given <code><span class='Number'>1</span><span class='Ligature'>āæ</span><span class='Number'>3</span><span class='Ligature'>āæ</span><span class='Number'>0</span><span class='Ligature'>āæ</span><span class='Number'>0</span></code>, <code><span class='Number'>2</span></code> is appended). After extension, it specifies a result axis for each axis of the right argument. There must be no gaps in the list: that is, with the result rank equal to one plus the greatest value present, every result axis must appear at least once. Now each argument axis is "sent to" the specified result axis: in terms of indices, <code><span class='Value'>i</span><span class='Function'>ā</span><span class='Value'>šØ</span><span class='Function'>ā</span><span class='Value'>š©</span></code> is <code><span class='Paren'>(</span><span class='Value'>šØ</span><span class='Function'>ā</span><span class='Value'>i</span><span class='Paren'>)</span><span class='Function'>ā</span><span class='Value'>š©</span></code> if <code><span class='Value'>šØ</span></code> is complete. If multiple argument axes correspond to the same result axis, then a diagonal is taken, and it's as long as the shortest of those argument axes. While Transpose does not enclose an atom right argument, Reorder Axes does, so that its result is always an array.</p> diff --git a/spec/primitive.md b/spec/primitive.md index ba5fae9b..b2d9b6ff 100644 --- a/spec/primitive.md +++ b/spec/primitive.md @@ -140,3 +140,7 @@ Modifiers for iteration are defined in layers 1, 2, and 4. Two 2-modifiers, `ā **Merge** (`>`) combines the outer axes of an array of arrays with inner axes: it requires that all elements of its argument have the same shape, and creates an array such that `(iā¾j)ā>š©` is `iājāš©`. It also accepts atom elements of `š©`, converting them to unit arrays, or an atom argument, which is returned unchanged. **Solo** and **Couple** (`ā`) turn one or two arguments into major cells of the result and can be defined easily in terms of Merge. **Join To** (`ā¾`) combines its two arguments along an existing initial axis, unless both arguments are units, in which case it creates an axis and is identical to Couple (`ā`). The arguments must differ in rank by at most 1, and the result rank is equal to the maximum of 1 and the higher argument rank. Each argument with rank less than the result, and each major cell of an argument with rank equal to it, becomes a major cell of the result, with cells from the left argument placed before those from the right. **Join** (`ā¾`) generalizes the equal-rank subset of this behavior to an array of values instead of just two. The argument must be an array (unlike Merge), and its elements must all the same rank, which is at least the argument rank. Atom elements are treated as unit arrays. Then "outer" argument axes are matched up with leading "inner" element axes, and elements are joined along these axes. In order to allow this, the length of an element along a particular axis must depend only on the position along the corresponding axis in the argument. An empty argument to Join is return unchanged, as though the element rank is equal to the argument rank. + +**Deshape** (`ā„`) differs from the provided function (which returns the element list of an array) only in that it accepts an atom, returning a one-element list containing it. **Reshape** (`ā„`) is extended in numerous ways. It accepts any list of natural numbers (including as a unit array or atom) for the left argument and any right argument; `š©` is deshaped first so that it is treated as a list of elements. These elements are repeated cyclically to fill the result array in ravel order. If `š©` is empty but the result is not, then the result consists of fill elements for `š©`. Furthermore, at most one element of `šØ` can be a "length code": one of the primitives `āāā½ā`. In this case, a target length is computed from the number of elements in `š©` divided by the product of the other elements of `šØ` (which must not be zero). If the target length is an integer then it is used directly for the length code. Otherwise, an error is given if the length code is `ā`, and the target length is rounded down if the code is `ā` and up if it's `ā½` or `ā`. With code `ā½`, elements are repeated cyclically as usual, but with code `ā`, the extra elements after each argument element is used are fill values for `š©`. + +**Transpose** (`ā`) reorders axes of its argument to place the first axis last; if the argument has one or fewer axes then it's returned unchanged. **Reorder Axes** (`ā`) requires the left argument to be a list or unit of natural numbers, with length at most the rank of the right argument. This list is extended to match the right argument rank exactly by repeatedly appending the least unused natural number (for example, given `1āæ3āæ0āæ0`, `2` is appended). After extension, it specifies a result axis for each axis of the right argument. There must be no gaps in the list: that is, with the result rank equal to one plus the greatest value present, every result axis must appear at least once. Now each argument axis is "sent to" the specified result axis: in terms of indices, `iāšØāš©` is `(šØāi)āš©` if `šØ` is complete. If multiple argument axes correspond to the same result axis, then a diagonal is taken, and it's as long as the shortest of those argument axes. While Transpose does not enclose an atom right argument, Reorder Axes does, so that its result is always an array. |