@stdlib/ndarray-base-assert-is-index-mode

Test if an input value is a supported ndarray index mode.

Usage no npm install needed!

<script type="module">
  import stdlibNdarrayBaseAssertIsIndexMode from 'https://cdn.skypack.dev/@stdlib/ndarray-base-assert-is-index-mode';
</script>

README

isIndexMode

NPM version Build Status Coverage Status

Test if an input value is a supported ndarray index mode.

Installation

npm install @stdlib/ndarray-base-assert-is-index-mode

Usage

var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );

isIndexMode( value )

Tests if an input value is a supported ndarray index mode.

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

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

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

Examples

var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );

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

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

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

bool = isIndexMode( '' );
// returns false

bool = isIndexMode( 'foo' );
// returns false

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-2022. The Stdlib Authors.