Package Exports

@stdlib/ndarray-casting-modes

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/ndarray-casting-modes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Casting Modes

List of ndarray casting modes.

Installation

npm install @stdlib/ndarray-casting-modes

Usage

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

modes()

Returns a list of ndarray casting modes.

var out = modes();
// returns [ 'none', 'equiv', 'safe', 'same-kind', 'unsafe' ]

The output array contains the following modes:

none: only allow casting between identical types.
equiv: allow casting between identical and byte swapped types.
safe: only allow "safe" casts.
same-kind: allow "safe" casts and casts within the same kind (e.g., between signed integers or between floats).
unsafe: allow casting between all types (including between integers and floats).

Examples

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

var MODES = modes();
var bool;

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

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

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

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

bool = isMode( 'same-kind' );
// returns true

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

bool = isMode( 'beep' );
// 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.

License

See LICENSE.

@stdlib/ndarray-casting-modes