Ambivalent function

In APL syntax, a function is ambivalent (sometimes variadic or nomadic), if it can be called with either monadic or dyadic valence. While every non-niladic function can be written with one or two arguments, some functions give a SYNTAX ERROR when called with two arguments (these functions are called monadic) or with only one (these are called dyadic). Ambivalent functions do not give a SYNTAX ERROR immediately in either case.

Being ambivalent, or not, is an inherent property of a function. This contrasts with the terms "monadic" and "dyadic" which may refer either to the function's inherent properties as described above or to the context in which it is used. When an ambivalent function is invoked it has either one argument or two: we would say for example it is an ambivalent function called monadically.

Tradfns

In some APLs, for example APL*PLUS, tradfns that declare a left argument in the function header are always ambivalent, and the code needs to check whether a left argument was supplied by the left argument name's name class; <syntaxhighlight lang=apl inline>0 ≠ ⎕NC 'leftArg'</source>. Other APLs, for example Dyalog APL, will not allow calling such a function monadically, unless the header has curly braces around the left argument name to indicate that it is optional; <syntaxhighlight lang=apl inline> result ← {leftArg} FnName rightArg</source>. Then too, they need to query the name class, or, unique for Dyalog APL, use a specialised Called Monadically I-beam, <syntaxhighlight lang=apl inline>900⌶⍬</source>.

Dfns

Dfns are always ambivalent, even if they reference <syntaxhighlight lang=apl inline>⍺</source>. (This is in contrast with dops which have a fixed operator valence determined by the presence of an unquoted <syntaxhighlight lang=apl inline>⍵⍵</source> in their code.) Like tradfns, the dfn can check the name class (<syntaxhighlight lang=apl inline>0 ≠ ⎕NC '⍺'</source>).

However, most APLs that support dfns also allow a statement of the structure <syntaxhighlight lang=apl inline>⍺ ← defaultValue</source> which skipped if the function was called dyadically. This syntax also allows assigning a function, or even an operator, to <syntaxhighlight lang=apl inline>⍺</source>, thus streamlining many ambivalent definitions. For example, we can create a Nth root function which defaults to being the square root when used monadically:

Try it online! <syntaxhighlight lang=apl> Root←{

   ⍺←2
   ⍵ * ÷⍺

} </source>

We can also define the Over operator with <syntaxhighlight lang=apl inline>⍺</source> defaulting to be an operator that skips its operand:

Try it online! <syntaxhighlight lang=apl> Over←{

   ⍺←{⍵ ⋄ ⍺⍺}
   (⍵⍵ ⍺) ⍺⍺ (⍵⍵ ⍵)

} </source>

External links

Tutorials

• John 'Jake' Jacob. Pervasion of Ambivalence in APL Functions. Optima Systems. July 9, 2020.

Documentation

• APLX
• Dyalog