0.2.1 • Published 3 months ago
@stdlib/ndarray-base-normalize-index v0.2.1
normalizeIndex
Normalize an index to the interval
[0,max]
.
Installation
npm install @stdlib/ndarray-base-normalize-index
Usage
var normalizeIndex = require( '@stdlib/ndarray-base-normalize-index' );
normalizeIndex( idx, max )
Normalizes an index to the interval [0,max]
.
var idx = normalizeIndex( 2, 10 );
// returns 2
idx = normalizeIndex( -5, 10 );
// returns 6
If provided an out-of-bounds index, the function returns -1
.
var idx = normalizeIndex( 15, 10 );
// returns -1
idx = normalizeIndex( -15, 10 );
// returns -1
Examples
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var normalizeIndex = require( '@stdlib/ndarray-base-normalize-index' );
var idx;
var out;
var i;
for ( i = 0; i < 100; i++ ) {
idx = discreteUniform( -20, 20 );
out = normalizeIndex( idx, 15 );
console.log( '%d => [%d,%d] => %d', idx, 0, 15, out );
}
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-2024. The Stdlib Authors.