@stdlib/ndarray-base-ind
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
About stdlib...

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!

ind

NPM version Build Status Coverage Status

Return an index given an index mode.

Installation

npm install @stdlib/ndarray-base-ind

Usage

var ind = require( '@stdlib/ndarray-base-ind' );

ind( idx, max, mode )

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>

// 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 6

ind.factory( mode )

Returns a function for returning an index according to a provided index mode.

var fcn = ind.factory( 'clamp' );

var idx = fcn( 2, 9 );
// returns 2

idx = fcn( 10, 9 );
// returns 9

idx = fcn( -1, 9 );
// returns 0

The function returns a function accepts the following arguments:

  • index: input index.
  • max: maximum index value.

Notes

  • Both functions support the following modes:

    • throw: specifies that the function should throw an error when an index is outside the interval [0, max].
    • normalize: specifies that the function should normalize negative indices and throw an error when an index is outside the interval [-max-1, max].
    • wrap: specifies that the function should wrap around an index using modulo arithmetic.
    • clamp: specifies that the function should set an index less than 0 to 0 (minimum index) and set an index greater than max to max.

Examples

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 );
}

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/ndarray-base-ind

Homepage

stdlib.io

Weekly Downloads

953

Version

0.2.1

License

Apache-2.0

Unpacked Size

48.5 kB

Total Files

15

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser