Index Modes

List of ndarray index modes.

Usage

var modes = require( '@stdlib/ndarray/index-modes' );

modes()

Returns a list of ndarray index modes.

var out = modes();
// returns [ 'throw', 'normalize', 'clamp', 'wrap' ]

The output array contains the following modes:

• throw: specifies that a function should throw an error when an index is outside a restricted interval.
• normalize: specifies that a function should normalize negative indices and throw an error when an index is outside a restricted interval.
• wrap: specifies that a function should wrap around an index using modulo arithmetic.
• clamp: specifies that a function should set an index less than 0 to 0 (minimum index) and set an index greater than a maximum index value to the maximum possible index.

Examples

var indexOf = require( '@stdlib/utils/index-of' );
var modes = require( '@stdlib/ndarray/index-modes' );

var MODES = modes();

function isMode( str ) {
    if ( indexOf( MODES, str ) === -1 ) {
        return false;
    }
    return true;
}

var bool = isMode( 'throw' );
// returns true

bool = isMode( 'normalize' );
// returns true

bool = isMode( 'clamp' );
// returns true

bool = isMode( 'wrap' );
// returns true

bool = isMode( 'beep' );
// returns false

---

See Also

• @stdlib/ndarray/array: multidimensional arrays.
• @stdlib/ndarray/ctor: multidimensional array constructor.