Return an index given an index mode.
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we’ve built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Return an index given an index mode.
bash
npm install @stdlib/ndarray-base-indscript tag without installation and bundlers, use the [ES Module][es-module] available on the [esm][esm-url] branch (see [README][esm-readme]).deno][deno-url] branch (see [README][deno-readme] for usage intructions).umd][umd-url] branch (see [README][umd-readme]).javascript
var ind = require( '@stdlib/ndarray-base-ind' );mode.javascript
var idx = ind( 2, 9, 'throw' );
// returns 2
idx = ind( -1, 9, 'throw' );
// throws <RangeError>
idx = ind( 10, 9, 'throw' );
// throws <RangeError>
// Wrapping indices around using modulo arithmetic:
idx = ind( 2, 9, 'wrap' );
// returns 2
idx = ind( 10, 9, 'wrap' );
// returns 0
idx = ind( -1, 9, 'wrap' );
// returns 9
// Clamping indices to first and last indices:
idx = ind( 2, 9, 'clamp' );
// returns 2
idx = ind( 10, 9, 'clamp' );
// returns 9
idx = ind( -1, 9, 'clamp' );
// returns 0
// Normalizing negative indices:
idx = ind( 2, 9, 'normalize' );
// returns 2
idx = ind( -4, 9, 'normalize' );
// returns 6mode.javascript
var fcn = ind.factory( 'clamp' );
var idx = fcn( 2, 9 );
// returns 2
idx = fcn( 10, 9 );
// returns 9
idx = fcn( -1, 9 );
// returns 0[0, max].[-max-1, max].0 to 0 (minimum index) and set an index greater than max to max.javascript
var 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 );
}
