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!

Index Modes

List of ndarray index modes.

Installation

npm install @stdlib/ndarray-index-modes

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

var modes = require( '@stdlib/ndarray-index-modes' );

modes()

Returns a list of ndarray index modes.

var out = modes();
// returns [ 'throw', 'normalize', 'clamp', 'wrap' ]

The output array contains the following modes:

• throw: specifies that a function should throw an error when an index is outside a restricted interval.
• normalize: specifies that a function should normalize negative indices and throw an error when an index is outside a restricted interval.
• wrap: specifies that a function should wrap around an index using modulo arithmetic.
• clamp: specifies that a function should set an index less than 0 to 0 (minimum index) and set an index greater than a maximum index value to the maximum possible index.

Examples

var indexOf = require( '@stdlib/utils-index-of' );
var modes = require( '@stdlib/ndarray-index-modes' );

var MODES = modes();

function isMode( str ) {
    if ( indexOf( MODES, str ) === -1 ) {
        return false;
    }
    return true;
}

var bool = isMode( 'throw' );
// returns true

bool = isMode( 'normalize' );
// returns true

bool = isMode( 'clamp' );
// returns true

bool = isMode( 'wrap' );
// returns true

bool = isMode( 'beep' );
// returns false

---

See Also

• @stdlib/ndarray-array: multidimensional arrays.
• @stdlib/ndarray-ctor: multidimensional array constructor.

---

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.