Data

Tools

Indexes

Applications

Experiments

Open Source Science

ndarray-base-normalize-indices

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

https://github.com/stdlib-js/ndarray-base-normalize-indices

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary

Keywords

array base idx ind index javascript multidimensional ndarray node node-js nodejs normalize stdlib subscript types util utilities utility utils
Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array base idx ind index javascript multidimensional ndarray node node-js nodejs normalize stdlib subscript types util utilities utility utils
Created 12 months ago · Last pushed 5 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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 <!-- dependencies -->

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

## Installation ```bash npm install @stdlib/ndarray-base-normalize-indices ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```javascript var normalizeIndices = require( '@stdlib/ndarray-base-normalize-indices' ); ``` #### normalizeIndices( indices, max ) Normalizes a list of indices to the interval `[0,max]`. ```javascript var idx = normalizeIndices( [ 2, -5 ], 10 ); // returns [ 2, 6 ] ``` If provided an out-of-bounds index, the function returns `null`. ```javascript 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 ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var normalizeIndices = require( '@stdlib/ndarray-base-normalize-indices' ); // 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][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 14
  • Create event: 6
Last Year
  • Push event: 14
  • Create event: 6