Return an index given an index mode.
npm install @stdlib/ndarray-base-indAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var ind = require( '@stdlib/ndarray-base-ind' );Returns an index given an index mode.
var idx = ind( 2, 9, 'throw' );
// returns 2
idx = ind( -1, 9, 'throw' );
// throws <RangeError>
idx = ind( 10, 9, 'throw' );
// throws <RangeError>The function supports the following modes:
throw: specifies that the function should throw an error when an index is outside the interval[0,max].wrap: specifies that the function should wrap around an index using modulo arithmetic.clamp: specifies that the function should set an index less than0to0(minimum index) and set an index greater thanmaxtomax.
var idx = ind( 2, 9, 'wrap' );
// returns 2
idx = ind( 10, 9, 'wrap' );
// returns 0
idx = ind( -1, 9, 'wrap' );
// returns 9
idx = ind( 2, 9, 'clamp' );
// returns 2
idx = ind( 10, 9, 'clamp' );
// returns 9
idx = ind( -1, 9, 'clamp' );
// returns 0var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var ind = require( '@stdlib/ndarray-base-ind' );
var modes;
var mode;
var idx;
var out;
var i;
modes = [ 'clamp', 'wrap' ];
for ( i = 0; i < 100; i++ ) {
idx = discreteUniform( -20, 20 );
mode = modes[ discreteUniform( 0, modes.length-1 ) ];
out = ind( idx, 9, mode );
console.log( '%d => %s(%d,%d) => %d', idx, mode, 0, 9, out );
}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.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
