index :: list

list.at

outputs list element(s) at specified index(es)

available since version: 0.1

---

information

Returns the element at the given index position in the list. @rel property allows to acess elements in range (-LIST_SIZE, LIST_SIZE). Negative index means position from the end of the list. For example: -1 returns last element. @clip property: if element index < 0 - first element returned. If element index >= LIST_SIZE last element returned. @wrap property: in range [0, LIST_SIZE) ordinal elements are returned. Other indexes are wrapped by modulo division.

arguments:

• INDEX single or multiple elements position
  type: list
  

properties:

• @method Get/set methods of processing of negative/invalid indexes
  type: symbol
  enum: rel, clip, fold, wrap
  default: rel
  

• @rel Get/set alias to @method rel. Negative index means position from the end of the list
  type: alias
  

• @clip Get/set alias to @method clip. If index < 0 - return first element. If index greater or equal list size - return last element
  type: alias
  

• @fold Get/set alias to @method fold. In range [0, LIST_SIZE) ordinal elements are returned. [LIST_SIZE, 2*LIST_SIZE) - returned in negative order etc.
  type: alias
  

• @wrap Get/set alias to @method wrap. In range [0, LIST_SIZE) ordinal elements are returned. Other indexes are wrapped by modulo division.
  type: alias
  

• @index Get/set indexes
  type: list
  default: 0
  

• @default Get/set default output value if not found. If not set, outputs error message to console
  type: atom
  default: null
  

inlets:

• input list
  type: control
• positions
  type: control

outlets:

• element(s) at the given index position(s). If element not found at specified position and @default property is set, output that default value
  type: control

keywords:

list

See also: [list.^at] [list.apply_to]

Authors: Serge Poltavsky

License: GPL3 or later