Skip to content

ndxarray

Forgiving array indexing

Syntax

i/kval ndxarray i/kArr[],i/kndx

i/kval = ndxarray(i/kArr[],i/kndx)

Usage

ndxarray returns the value at the index in an array. Indices wrap around the array length, so no index is 'out of bounds'. negative indices count backwards from the end of the array.

Outputs and arguments

i/kval -- Output element returned from the index position of the array.

i/kArr[] -- input array

i/kndx -- index in the array to retrieve the value. Can be fractional, greater than lenarray(iArr), and negative. Fractional indices are floored. Negative indices count from the end of the array at -1.

Example

    iArr fillarray 4.5,4.6,4.7,4.8

    ival1 = ndxarray(iArr,2.999)     ;; ival1 == 4.7
    ival2 = ndxarray(iArr,5) => 4.6  ;; ival2 == 4.6
    ival3 = ndxarray(iArr,-2) => 4.7 ;; ival3 == 4.7