List of ndarray index modes.
npm install @stdlib/ndarray-index-modesWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> List of ndarray index modes.
``bash`
npm install @stdlib/ndarray-index-modes
`javascript`
var modes = require( '@stdlib/ndarray-index-modes' );
#### modes()
Returns a list of ndarray index modes.
`javascript`
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.
`javascript
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
`
*
- [@stdlib/ndarray-array][@stdlib/ndarray/array]: multidimensional arrays.
- [@stdlib/ndarray-ctor][@stdlib/ndarray/ctor]: multidimensional array constructor.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-index-modes.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-index-modes
[test-image]: https://github.com/stdlib-js/ndarray-index-modes/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/ndarray-index-modes/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-index-modes/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-index-modes?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/ndarray-index-modes/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-index-modes/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-index-modes/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-index-modes/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-index-modes/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-index-modes/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-index-modes/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-index-modes/main/LICENSE
[@stdlib/ndarray/array]: https://www.npmjs.com/package/@stdlib/ndarray-array
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor