Function axis: Difference between revisions
m (General editing for GNU discussion) 
m (Text replacement  "</source>" to "</syntaxhighlight>") 

Line 1:  Line 1:  
{{BuiltinFunction axis[ax]}} is a special syntax which modifies the behavior of a function, for example <source lang=apl inline>⌽[2]</  {{BuiltinFunction axis[ax]}} is a special syntax which modifies the behavior of a function, for example <source lang=apl inline>⌽[2]</syntaxhighlight> to [[Rotate]] along the second [[axis]]. Axis specification was a feature of [[Iverson notation]] and was ubiquitous in early APLs; many newer APLs which adhere to [[leading axis theory]] reject the use of axis specification in favor of the [[Rank operator]] because it is a fully general operator while the behavior of functions with axis must be defined for each function separately. However, [[GNU APL]] implements the syntax and extends it so it applies to all userdefined functions.  
== Functions ==  == Functions ==  
Line 29:  Line 29:  
== Generalisation ==  == Generalisation ==  
GNU APL generalises function axis to all functions, and beyond cases that refer to one or more argument axes. The axis works like an additional argument, which the function can use in any way. For example, <source lang=apl inline>⌹[ax] M</  GNU APL generalises function axis to all functions, and beyond cases that refer to one or more argument axes. The axis works like an additional argument, which the function can use in any way. For example, <source lang=apl inline>⌹[ax] M</syntaxhighlight> computes the [[wikipedia:QR factorizationQR factorization]] of <source lang=apl inline>M</syntaxhighlight> with the [[comparison tolerance]] of <source lang=apl inline>ax</syntaxhighlight>. Here, <source lang=apl inline>ax</syntaxhighlight> is not an axis at all, and there's no direct connection between this monadic usage of Domino and its nonaxis meaning of [[Matrix inverse]]. Thus there is no value for <source lang=apl inline>ax</syntaxhighlight> such that <source lang=apl inline>f[ax]</syntaxhighlight> is the same as <source lang=apl inline>f</syntaxhighlight>, which is usually the case for existing axis definitions (not scalar functions). Much like the left argument of [[Circular]] (<source lang=apl inline>○</syntaxhighlight>), The GNU APL specific File Input Output [[system function]] (<source lang=apl inline>⎕FIO</syntaxhighlight>) uses the bracket axis syntax as a function selector, as does the [[wikipedia:SQLSQL]] interface function (<source lang=apl inline>⎕SQL</syntaxhighlight>). Some of the options for <source lang=apl inline>⎕SQL</syntaxhighlight> take additional parameters as subsequent elements of the array inside the brackets. Similarly, the [[wikipedia:regular expressionregular expression]] interface (<source lang=apl inline>⎕RE</syntaxhighlight>) uses [[character]] "axes" as flags for the regular expression engine, where [[Dyalog APL]] uses a [[dyadic operator]], [[Variant]] (<source lang=apl inline>⍠</syntaxhighlight>), for analogous functionality.  
GNU APL additionally gives userdefined functions, both [[dfn]]s and [[tradfn]]s, access to the bracket axis syntax, again while permitting its use for any purpose. For example, the [[root]] function could be implemented as a monadic function with axis specifying the degree, rather than as a dyadic function. In a dfn, the value given via axis notation is denoted <source lang=apl inline>χ</  GNU APL additionally gives userdefined functions, both [[dfn]]s and [[tradfn]]s, access to the bracket axis syntax, again while permitting its use for any purpose. For example, the [[root]] function could be implemented as a monadic function with axis specifying the degree, rather than as a dyadic function. In a dfn, the value given via axis notation is denoted <source lang=apl inline>χ</syntaxhighlight>:  
<source lang=apl>  <source lang=apl>  
Root←{⍵*÷χ}  Root←{⍵*÷χ}  
Root[3]8  Root[3]8  
2  2  
</  </syntaxhighlight>  
{{Works in[[GNU APL]]}}  {{Works in[[GNU APL]]}}  
Or as a tradfn, indicating axis notation in the header line:  Or as a tradfn, indicating axis notation in the header line:  
Line 43:  Line 43:  
r←y*÷ax  r←y*÷ax  
∇  ∇  
</  </syntaxhighlight>  
{{Works in[[GNU APL]]}}  {{Works in[[GNU APL]]}}  
Revision as of 22:08, 10 September 2022
[ax]

Function axis ([ax]
) is a special syntax which modifies the behavior of a function, for example <source lang=apl inline>⌽[2]</syntaxhighlight> to Rotate along the second axis. Axis specification was a feature of Iverson notation and was ubiquitous in early APLs; many newer APLs which adhere to leading axis theory reject the use of axis specification in favor of the Rank operator because it is a fully general operator while the behavior of functions with axis must be defined for each function separately. However, GNU APL implements the syntax and extends it so it applies to all userdefined functions.
Functions
Monadic functions
The following monads may allow an axis:
 Mix accepts a list of axes to specify where the axes of argument elements will be placed in the result.
 Ravel accepts a list of axes which are combined, or a single fractional number to add a length1 axis.
 Enclose accepts a list of axes. Each subarray along these axes is enclosed.
 Split accepts a single axis, and encloses each vector along that axis.
 Reverse reverses along the specified axis.
Dyadic functions
The following dyads may allow one:
 Scalar dyadics accept a list of axes to override conformability rules: it specifies , for each axis in the lowerrank (or left, in case of a tie) argument, which axis in the other argument it is paired with.
 Catenate combines along the selected axis, adding a new axis if a noninteger axis is given.
 Rotate rotates the right argument along the selected axis.
 Replicate and Expand work on the specified right argument axis.
 Take and Drop modify the selected right argument axes.
 Squad indexing takes axes to specify which axis of the right argument corresponds to each left argument element.
 Partition and Partitioned Enclose have complicated and different behavior.
Operators
The following operators may admit axis specification:
 Reduction removes the specified right argument axis.
 Scan works on the specified right argument axis.
In SHARP APL, Replicate and Expand are also included in this category as they are operators and not functions.
Axis specification always modifies the derived function obtained from an operator, and not the operator itself. The exact syntax may vary: in most cases a set of brackets is parsed like a monadic operator and applies directly to the derived function; sometimes brackets can be applied directly to an operator, in which case the derived function produced by this operator is modified. In Dyalog APL, a slash with axis retains its functionoperator overloading: it can be applied as an operator or as a dyadic function (Replicate or Expand).
Generalisation
GNU APL generalises function axis to all functions, and beyond cases that refer to one or more argument axes. The axis works like an additional argument, which the function can use in any way. For example, <source lang=apl inline>⌹[ax] M</syntaxhighlight> computes the QR factorization of <source lang=apl inline>M</syntaxhighlight> with the comparison tolerance of <source lang=apl inline>ax</syntaxhighlight>. Here, <source lang=apl inline>ax</syntaxhighlight> is not an axis at all, and there's no direct connection between this monadic usage of Domino and its nonaxis meaning of Matrix inverse. Thus there is no value for <source lang=apl inline>ax</syntaxhighlight> such that <source lang=apl inline>f[ax]</syntaxhighlight> is the same as <source lang=apl inline>f</syntaxhighlight>, which is usually the case for existing axis definitions (not scalar functions). Much like the left argument of Circular (<source lang=apl inline>○</syntaxhighlight>), The GNU APL specific File Input Output system function (<source lang=apl inline>⎕FIO</syntaxhighlight>) uses the bracket axis syntax as a function selector, as does the SQL interface function (<source lang=apl inline>⎕SQL</syntaxhighlight>). Some of the options for <source lang=apl inline>⎕SQL</syntaxhighlight> take additional parameters as subsequent elements of the array inside the brackets. Similarly, the regular expression interface (<source lang=apl inline>⎕RE</syntaxhighlight>) uses character "axes" as flags for the regular expression engine, where Dyalog APL uses a dyadic operator, Variant (<source lang=apl inline>⍠</syntaxhighlight>), for analogous functionality.
GNU APL additionally gives userdefined functions, both dfns and tradfns, access to the bracket axis syntax, again while permitting its use for any purpose. For example, the root function could be implemented as a monadic function with axis specifying the degree, rather than as a dyadic function. In a dfn, the value given via axis notation is denoted <source lang=apl inline>χ</syntaxhighlight>: <source lang=apl>
Root←{⍵*÷χ} Root[3]8
2 </syntaxhighlight>
Or as a tradfn, indicating axis notation in the header line: <source lang=apl> ∇ r←Root[ax] y
r←y*÷ax
∇ </syntaxhighlight>