index :: list

list.walk

Walks thru the list

available since version: 0.1

---

information

Universal list walker. If you want to output current element and when move to next - use [1( message, Otherwise - use [next( if you want first move to next position and then output it.

arguments:

• VALUE initial list
  type: list
  

methods:

• current outputs current element
  

• dump dump internal object state to Pd console window
  

• next
  parameters:
  • [STEP=1] moves to next element with optional given step and outputs it
    type: int
    
• prev
  parameters:
  • [STEP=1] moves to previous element with optional given step and outputs it
    type: int
    
• reset sets current position to 0
  

properties:

• @mode Get/set pass mode. See properties below for detailed information.
  type: symbol
  enum: single, clip, wrap, fold
  default: single
  

• @clip Get/set clipped pass mode. When the list bounds are reached - min/max value repeats perpetually.
  type: alias
  

• @single Get/set single pass mode. When the list bounds are reached - no output any more until reset.
  type: alias
  

• @loop Get/set @wrap alias
  type: alias
  

• @wrap Get/set wrap pass mode. List values are repeated in a loop
  type: alias
  

• @fold Get/set fold pass mode. List values are repeated in a loop with folding
  type: alias
  

• @direction Get/set walking direction. "1" - forwards, "0" - backwards.
  type: bool
  default: 1
  

• @index Get/set current position
  type: list
  min value: 0
  default: 0
  

• @length Get/set output list length
  type: int
  min value: 1
  default: 1
  

• @size (readonly) Get current list size
  type: int
  min value: 0
  default: 0
  

• @value Get/set current list
  type: list
  

inlets:

• outputs current element and moves to next
  type: control

outlets:

• list element
  type: control
• bang: when last element reached
  type: control

keywords:

list walk iterate

See also: [list.gen] [list.seq]

Authors: Serge Poltavsky

License: GPL3 or later