README
Index Modes
List of ndarray index modes.
Installation
npm install @stdlib/ndarray-index-modes
Usage
var modes = require( '@stdlib/ndarray-index-modes' );
modes()
Returns a list of ndarray index modes.
var out = modes();
// returns [ 'throw', '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.wrap
: specifies that a function should wrap around an index using modulo arithmetic.clamp
: specifies that a function should set an index less than0
to0
(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();
var bool;
function isMode( str ) {
if ( indexOf( MODES, str ) === -1 ) {
return false;
}
return true;
}
bool = isMode( 'throw' );
// returns true
bool = isMode( 'clamp' );
// returns true
bool = isMode( 'wrap' );
// returns true
bool = isMode( 'beep' );
// returns false
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.