# Array notation: Difference between revisions

(Note differences between dzaima/APL and Dyalog APL) |
(Note solicitation of feedback) |
||

Line 1: | Line 1: | ||

'''Array notation''' is a way to write most [[array]]s literally, with no or minimal use of [[primitive function]]s, possibly over multiple code lines. It differs from the [[strand notation]], existing since [[APL\360]], in that it can be used to write arrays of [[rank]] greater than one. This article describes the syntax supported in [[dzaima/APL]], and by some tools for [[Dyalog APL]], | '''Array notation''' is a way to write most [[array]]s literally, with no or minimal use of [[primitive function]]s, possibly over multiple code lines. It differs from the [[strand notation]], existing since [[APL\360]], in that it can be used to write arrays of [[rank]] greater than one. This article describes the syntax supported in [[dzaima/APL]], and by some tools for [[Dyalog APL]]. [[Dyalog Ltd]] plans to add the notation as a language feature, but has requested community feedback in the hope of ending up with a notation that is shared with other dialects.<ref>Dyalog Ltd/Adám Brudzewsky. [https://forums.dyalog.com/viewtopic.php?f=13&t=1856&p=7431#p7431 Re: Deserialise-- does it work as expected?]. Dyalog Forums. 2022-09-05.</ref>. Such feedback can be left at the discussion page for the [[Array notation design considerations]] article. | ||

The array notation consists of a vector notation written with round parentheses <source lang=apl inline>()</source>, roughly equivalent to stranding, and a high-rank notation using square brackets <source lang=apl inline>[]</source>, indicating the [[Mix]] of a vector. It also supports [[namespace]]s, using <source lang=apl inline>name:value</source> syntax in round parentheses. Elements and [[wikipedia:name–value_pair|name–value_pair]]s are separated by [[statement separator]]s; [[Diamond]]s (<source lang=apl inline>⋄</source>) or line breaks. | The array notation consists of a vector notation written with round parentheses <source lang=apl inline>()</source>, roughly equivalent to stranding, and a high-rank notation using square brackets <source lang=apl inline>[]</source>, indicating the [[Mix]] of a vector. It also supports [[namespace]]s, using <source lang=apl inline>name:value</source> syntax in round parentheses. Elements and [[wikipedia:name–value_pair|name–value_pair]]s are separated by [[statement separator]]s; [[Diamond]]s (<source lang=apl inline>⋄</source>) or line breaks. |

## Revision as of 12:24, 5 September 2022

**Array notation** is a way to write most arrays literally, with no or minimal use of primitive functions, possibly over multiple code lines. It differs from the strand notation, existing since APL\360, in that it can be used to write arrays of rank greater than one. This article describes the syntax supported in dzaima/APL, and by some tools for Dyalog APL. Dyalog Ltd plans to add the notation as a language feature, but has requested community feedback in the hope of ending up with a notation that is shared with other dialects.^{[1]}. Such feedback can be left at the discussion page for the Array notation design considerations article.

The array notation consists of a vector notation written with round parentheses `()`

, roughly equivalent to stranding, and a high-rank notation using square brackets `[]`

, indicating the Mix of a vector. It also supports namespaces, using `name:value`

syntax in round parentheses. Elements and name–value_pairs are separated by statement separators; Diamonds (`⋄`

) or line breaks.

## Examples

Medium-sized array constants are often needed in code. Due to the lack of a native multi-line notation, programmers have resorted to various ad-hoc methods of approximating such, usually at the cost of reduced readability. A very common technique is repeated concatenation:

```
poss←1 2⍴'fns' ((0 1)(0.7 0)(0.7 0)×size)
poss⍪← 'fnd' ((0 1)(0 0)(0 0)×size)
poss⍪← 'lines'((0 0)(0.7 0)(0.7 0)×size)
poss⍪← 'lnd' ((0 0)(0 0)(0 0)×size)
```

Array notation allows this multi-line construction to be made with a single assignment, and also provides an alternate syntax for the inner vectors of vectors:

```
poss←['fns' ((0 1 ⋄ 0.7 0 ⋄ 0.7 0)×size)
'fnd' ((0 1 ⋄ 0 0 ⋄ 0 0)×size)
'lines'((0 0 ⋄ 0.7 0 ⋄ 0.7 0)×size)
'lnd' ((0 0 ⋄ 0 0 ⋄ 0 0)×size)]
```

## Description

The notation consists of syntax that was invalid before its introduction, thus causing no issues for backwards compatibility. The added syntax consists of three constructs that are currently SYNTAX ERRORs:

*broken*round parentheses:`(`

…`)`

*broken*square brackets:`[`

…`]`

- empty round parentheses:
`()`

where *broken* means interrupted by one or more diamonds (`⋄`

) or line breaks (outside of dfns).

- A
*broken*round parenthesis creates a namespace if every diamond/line break-separated statement is a*name-value pair*. - A
*broken*round parenthesis creates a vector if every diamond/line break-separated statement is a value expression. In that case, every such statement forms an element in the resulting vector. - A
*broken*square bracket creates a an array where every diamond/line break-separated statement forms a major cell in the resulting array.* `()`

is equivalent to`(⎕NS 0⍴⊂'')`

- A
*name-value pair*consist of a valid APL identifier, followed by a`:`

and a value expression.

* This rule is followed strictly in dzaima/APL, while Dyalog APL considers each statement to have a rank of at least 1, even if it is a scalar.

### Formal syntax

The array notation can be described using Extended Backus–Naur form, where an `expression`

is any traditional APL expression:

value ::= expression | list | block | space list ::= '(' ( ( value sep )+ value? | ( sep value )+ sep? ) ')' block ::= '[' ( ( value sep )+ value? | ( sep value )+ sep? ) ']' space ::= '(' sep? ( name ':' value ( sep name ':' value )* )? sep? ')' sep ::= [⋄#x000A#x000D#x0085]+

## History

*See also the Array notation design considerations#Timeline*

One-dimensional list syntax with surrounding brackets and delimiters, matching sequence notation in mathematics, is common in programming. It appears as early as ALGOL 68 with parentheses, and square-bracket lists feature in languages from the 1970s such as ML and Icon. MATLAB uses matrix syntax with square brackets, semicolons to separate rows, and commas to separate elements within a row. FP uses angle brackets for lists, and square brackets for function "construction", with behavior like function arrays.

List notation appears in Nial using brackets and commas like `[a,b,c]`

, and allowing function arrays called "atlases". A+ and K have a list notation using parentheses and semicolons like `(a;b;c)`

. In A+ this is related to bracket indexing and an "expression group" notation written with curly braces and semicolons. It allows line breaks, but in addition to rather than in place of semicolons. The later K version corresponds more closely to APL: the semicolon is a statement separator and is interchangeable with a line break, and because K represents arrays with nested lists, it corresponds to both vector and high-rank array notation.

The first published proposals that influenced Dyalog APL's array notation were made by Phil Last at Dyalog '15 and later in Vector Journal.^{[2]}^{[3]} Last cited the syntax of dfns as a sequence of expressions with enclosing braces, as well as APL#'s namespace notation enclosed in double brackets `[[]]`

, as precursors. He also used the design in Acre Desktop, a project manager for Dyalog APL, to support storing constant arrays and namespaces in text files. Following the conference presentation, Adám Brudzewsky began work on array notation and presented on it in a series of conferences, initially using parentheses for the high-rank notation^{[4]} and later returning to square brackets.^{[5]}^{[6]} Because Last's use of `←`

to separate namespace keys from values prevented lists from including arbitrary expressions (which might contain assignment), he proposed a change to `:`

as in JSON. Dyalog APL 18.0, released in 2020, included support for array notation in source files loaded by Link^{[7]}, but not in the language itself.^{[8]}

The project manager Acre Desktop added support for the non-namespace parts of the notation in early 2018, together with Phil Last's original namespace notation, using square brackets and assignment arrow. dzaima/APL added support for vector notation with parentheses in 2018, namespaces and function arrays in 2019, and high-rank arrays with square brackets in 2020. BQN supported lists with angle brackets (`⟨`

…`⟩`

) in its initial implementation in 2020; square brackets (`[`

…`]`

) were reserved for high-rank array notation, which was implemented in 2022.

## References

- ↑ Dyalog Ltd/Adám Brudzewsky. Re: Deserialise-- does it work as expected?. Dyalog Forums. 2022-09-05.
- ↑ Phil Last. APL Array Notation (transcript). Dyalog '15.
- ↑ Phil Last. A Notation for APL array Embedding and Serialization. Vector Journal, Volume 26, number 4. British APL Association. 2016.
- ↑ Adám Brudzewsky. Literal Notation for Arrays and Namespaces (slides). Dyalog '17.
- ↑ Adám Brudzewsky. Array Notation Mk III. Dyalog '18.
- ↑ Adám Brudzewsky. A Notation for APL Arrays. APL-Journal, Volume 2020, number 1-2. APL-Germany e.V. 2020.
- ↑ Dyalog Ltd. Link User Guide: Creating APL Source Files and Directories. Retrieved 2022-08-24.
- ↑ Adám Brudzewsky. Array Notation RC1 (slides). Dyalog '20.