4,493
edits
Index (function): Difference between revisions
Jump to navigation
Jump to search
m
Text replacement - "<source" to "<syntaxhighlight"
m (Text replacement - "http://help.dyalog.com" to "https://help.dyalog.com") |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| Line 1: | Line 1: | ||
:''This article describes a dyadic primitive function that performs indexing into an array. For the concept of array indices, see [[Index]]. For the concept of extracting items from an array, see [[Indexing]].'' | :''This article describes a dyadic primitive function that performs indexing into an array. For the concept of array indices, see [[Index]]. For the concept of extracting items from an array, see [[Indexing]].'' | ||
{{Built-in|Index|⌷}}, also called '''Squad Indexing''' after the name of the [[glyph]], is a [[dyadic]] [[primitive function]]. The result of < | {{Built-in|Index|⌷}}, also called '''Squad Indexing''' after the name of the [[glyph]], is a [[dyadic]] [[primitive function]]. The result of <syntaxhighlight lang=apl inline>X⌷Y</source> is an array formed with items of Y extracted by the [[index]] specification X. Index is a proper [[function]] alternative to a mode of [[bracket indexing]] (which uses a dedicated syntax <syntaxhighlight lang=apl inline>Y[X]</source>), making it usable within [[tacit programming]]. It shares its glyph with the monadic [[Materialise]] function. | ||
== Examples == | == Examples == | ||
The left [[argument]] X must be a [[vector]] whose length equals the [[rank]] of the right argument Y and [[depth]] does not exceed 2. Each element of X selects one or more indices over the corresponding [[axis]] of the right argument Y. The result is identical to that of [[bracket indexing]] in that < | The left [[argument]] X must be a [[vector]] whose length equals the [[rank]] of the right argument Y and [[depth]] does not exceed 2. Each element of X selects one or more indices over the corresponding [[axis]] of the right argument Y. The result is identical to that of [[bracket indexing]] in that <syntaxhighlight lang=apl inline>Y[X1;X2;…;Xn] ≡ X1 X2 … Xn⌷Y</source>. The resulting [[shape]] equals the [[catenate|concatenation]] of the shapes of each element of X. | ||
< | <syntaxhighlight lang=apl> | ||
VEC←111 222 333 444 | VEC←111 222 333 444 | ||
3⌷VEC | 3⌷VEC | ||
| Line 27: | Line 27: | ||
</source> | </source> | ||
When used with [[function axis]] in the form of < | When used with [[function axis]] in the form of <syntaxhighlight lang=apl inline>X⌷[K]Y</source>, K specifies a subset of [[axes]] of Y to apply indexing on. The axes not mentioned in K are selected without modification; this corresponds to omitted axes in bracket indexing. | ||
< | <syntaxhighlight lang=apl> | ||
⎕←CUBE←10⊥¨⍳2 3 4 | ⎕←CUBE←10⊥¨⍳2 3 4 | ||
111 112 113 114 | 111 112 113 114 | ||
| Line 52: | Line 52: | ||
</source> | </source> | ||
In some dialects that support [[leading axis theory]], short X in < | In some dialects that support [[leading axis theory]], short X in <syntaxhighlight lang=apl inline>X⌷Y</source> selects from leading axes of Y. In that case, the trailing axes are selected without modification. | ||
< | <syntaxhighlight lang=apl> | ||
MAT←10⊥¨⍳3 4 ⍝ Same as the first example | MAT←10⊥¨⍳3 4 ⍝ Same as the first example | ||
2⌷MAT ⍝ Second axis omitted | 2⌷MAT ⍝ Second axis omitted | ||
| Line 62: | Line 62: | ||
== Implementation support == | == Implementation support == | ||
This form of indexing is supported in [[J]] as boxed left argument of '''From''' < | This form of indexing is supported in [[J]] as boxed left argument of '''From''' <syntaxhighlight lang=j inline>{</source>. | ||
== See also == | == See also == | ||