README

Clamp Index

Restrict an index to the interval [0,max].

Installation

npm install @stdlib/ndarray-base-clamp-index

Usage

var clampIndex = require( '@stdlib/ndarray-base-clamp-index' );

clampIndex( idx, max )

Restricts an index to the interval [0,max].

var idx = clampIndex( 2, 10 );
// returns 2

idx = clampIndex( -5, 10 );
// returns 0

idx = clampIndex( 15, 10 );
// returns 10

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var clampIndex = require( '@stdlib/ndarray-base-clamp-index' );

var idx;
var out;
var i;

for ( i = 0; i < 100; i++ ) {
    idx = discreteUniform( -20, 20 );
    out = clampIndex( idx, 10 );
    console.log( '%d => [%d,%d] => %d', idx, 0, 10, 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.

@stdlib/ndarray-base-clamp-index

Usage no npm install needed!