8000 GitHub - stdlib-js/ndarray-base-normalize-indices at deno
[go: up one dir, main page]

Skip to content

stdlib-js/ndarray-base-normalize-indices

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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!

normalizeIndices

NPM version Build Status Coverage Status

Normalize a list of indices to the interval [0,max].

Usage

import normalizeIndices from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-normalize-indices@deno/mod.js';

normalizeIndices( indices, max )

Normalizes a list of indices to the interval [0,max].

var idx = normalizeIndices( [ 2, -5 ], 10 );
// returns [ 2, 6 ]

If provided an out-of-bounds index, the function returns null.

var idx = normalizeIndices( [ 15, -15 ], 10 );
// returns null

Notes

  • The function mutates the input array, even when provided an out-of-bounds index. If mutation is undesired, copy the input array before calling this function.
  • During normalization, a negative index is converted to a nonnegative index according to max + idx + 1. If, after normalization, the resolved index is still negative, the value is considered out-of-bounds.

Examples

import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@deno/mod.js';
import normalizeIndices from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-normalize-indices@deno/mod.js';

// Generate a list of random indices:
var idx1 = discreteUniform( 100, -20, 20, {
    'dtype': 'generic'
});

// Normalize each index to the interval `[0, 15]`:
var idx2 = idx1.slice();
var out = normalizeIndices( idx2, 15 );

// Check whether one or more indices was invalid:
if ( out === null ) {
    console.log( 'One or more indices was invalid.' );
}

// Print the results...
var i;
for ( i = 0; i < idx1.length; i++ ) {
    console.log( '%d => [%d, %d] => %d', idx1[ i ], 0, 15, idx2[ i ] );
}

Notice

This package is part of stdlib, a standard library 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-2025. The Stdlib Authors.

0