Index origin

From APL Wiki
Revision as of 21:59, 10 September 2022 by Adám Brudzewsky (talk | contribs) (Text replacement - "</source>" to "</syntaxhighlight>")
Jump to navigation Jump to search

Index origin (⎕IO) is the number used for the first index along each axis of an array. Many APLs allow the user to configure index origin using the system variable <source lang=apl inline>⎕IO</syntaxhighlight>. Even array languages which do not have such a configuration parameter must make a choice of index origin; for example, A+ and J use a non-configurable index origin of 0. The English language uses an index origin of one: thus the element with index <source lang=apl inline>⎕IO</syntaxhighlight> in APL is referred to in English as the "first" element.

The index origin affects both the handling of index arguments to functions (and other functionality like axis specification) and their results. For example, Index Generator creates results that begin with <source lang=apl inline>⎕IO</syntaxhighlight>. <source lang=apl> 

     ⎕IO←0
     ⍳4

0 1 2 3 

     ⎕IO←1
     ⍳4

1 2 3 4 </syntaxhighlight>

Any number could consistently be used for the index origin, but almost all APLs restrict the choice to 0 or 1. ngn/apl supports <source lang=apl inline>⎕IO</syntaxhighlight> but only allows it to have the value 0. Attempting to assign an unsupported value to <source lang=apl inline>⎕IO</syntaxhighlight> typically results in a DOMAIN ERROR.

The choice of which numbers are indices is subjective and must be made by the language designer. In some cases there is no clear decision: Interval Index and Occurrence Count each have natural definitions that depend on index origin, and natural definitions that do not.

Functions which depend on index origin

The following functions depend on <source lang=apl inline>⎕IO</syntaxhighlight> in at least some APLs. They are listed with the glyphs used for them in Dyalog APL. For functions, only the result depends on <source lang=apl inline>⎕IO</syntaxhighlight> except where noted with <source lang=apl inline>⍺</syntaxhighlight> in which case the left argument does instead. For operators the dependence is noted.

Monadic functions Dyadic functions Operators
Index Generator (<source lang=apl inline>⍳</syntaxhighlight>) Index-Of (<source lang=apl inline>⍳</syntaxhighlight>) Key (<source lang=apl inline>⌸</syntaxhighlight>) argument to <source lang=apl inline>⍺⍺</syntaxhighlight>
Roll (<source lang=apl inline>?</syntaxhighlight>) Deal (<source lang=apl inline>?</syntaxhighlight>) At (<source lang=apl inline>@</syntaxhighlight>) result of <source lang=apl inline>⍵⍵</syntaxhighlight>
Grade (<source lang=apl inline>⍒⍋</syntaxhighlight>) (<source lang=apl inline>⍒⍋</syntaxhighlight>)
Indices (<source lang=apl inline>⍸</syntaxhighlight>) Interval Index (<source lang=apl inline>⍸</syntaxhighlight>)
Transpose (<source lang=apl inline>⍉</syntaxhighlight>) <source lang=apl inline>⍺</syntaxhighlight>
Pick (<source lang=apl inline>⊃</syntaxhighlight>) <source lang=apl inline>⍺</syntaxhighlight>
Squad (<source lang=apl inline>⌷</syntaxhighlight>) <source lang=apl inline>⍺</syntaxhighlight>

Additionally, indexing with brackets and axis specification depend on index origin.

External links

Articles

Lessons

Documentation

APL built-ins [edit]
Primitives (Timeline) Functions
Scalar
Monadic Conjugate ∙ Negate ∙ Signum ∙ Reciprocal ∙ Magnitude ∙ Exponential ∙ Natural Logarithm ∙ Floor ∙ Ceiling ∙ Factorial ∙ Not ∙ Pi Times ∙ Roll ∙ Type ∙ Imaginary ∙ Square Root ∙ Round
Dyadic Add ∙ Subtract ∙ Times ∙ Divide ∙ Residue ∙ Power ∙ Logarithm ∙ Minimum ∙ Maximum ∙ Binomial ∙ Comparison functions ∙ Boolean functions (And, Or, Nand, Nor) ∙ GCD ∙ LCM ∙ Circular ∙ Complex ∙ Root
Non-Scalar
Structural Shape ∙ Reshape ∙ Tally ∙ Depth ∙ Ravel ∙ Enlist ∙ Table ∙ Catenate ∙ Reverse ∙ Rotate ∙ Transpose ∙ Raze ∙ Mix ∙ Split ∙ Enclose ∙ Nest ∙ Cut (K) ∙ Pair ∙ Link ∙ Partitioned Enclose ∙ Partition
Selection First ∙ Pick ∙ Take ∙ Drop ∙ Unique ∙ Identity ∙ Stop ∙ Select ∙ Replicate ∙ Expand ∙ Set functions (Intersection ∙ Union ∙ Without) ∙ Bracket indexing ∙ Index ∙ Cartesian Product ∙ Sort
Selector Index generator ∙ Grade ∙ Index Of ∙ Interval Index ∙ Indices ∙ Deal ∙ Prefix and suffix vectors
Computational Match ∙ Not Match ∙ Membership ∙ Find ∙ Nub Sieve ∙ Encode ∙ Decode ∙ Matrix Inverse ∙ Matrix Divide ∙ Format ∙ Execute ∙ Materialise ∙ Range
Operators Monadic Each ∙ Commute ∙ Constant ∙ Replicate ∙ Expand ∙ Reduce ∙ Windowed Reduce ∙ Scan ∙ Outer Product ∙ Key ∙ I-Beam ∙ Spawn ∙ Function axis ∙ Identity (Null, Ident)
Dyadic Bind ∙ Compositions (Compose, Reverse Compose, Beside, Withe, Atop, Over) ∙ Inner Product ∙ Determinant ∙ Power ∙ At ∙ Under ∙ Rank ∙ Depth ∙ Variant ∙ Stencil ∙ Cut ∙ Direct definition (operator) ∙ Identity (Lev, Dex)
Quad names Index origin ∙ Comparison tolerance ∙ Migration level ∙ Atomic vector
Retrieved from ‘https://aplwiki.com/index.php?title=Index_origin&oldid=9364’