Return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind".
npm install @stdlib/ndarray-same-kind-castsAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var sameKindCasts = require( '@stdlib/ndarray-same-kind-casts' );If provided a dtype argument, returns a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind" (e.g., between signed integers or between floating-point numbers).
var out = sameKindCasts( 'float64' );
// e.g., returns [ 'float64', 'float32', ... ]If not provided a dtype argument, the function returns a casting table.
var out = sameKindCasts();
// returns {...}
var f64 = out[ 'float64' ];
// returns {...}
var v = f64[ 'float32' ];
// returns 1If provided an unrecognized or unsupported dtype, the function returns null.
var out = sameKindCasts( 'foo' );
// returns nullvar dtypes = require( '@stdlib/ndarray-dtypes' );
var sameKindCasts = require( '@stdlib/ndarray-same-kind-casts' );
var DTYPES;
var list;
var i;
// Get the list of supported ndarray data types:
DTYPES = dtypes();
// Print the list of ndarray data types to which a data type can be cast...
for ( i = 0; i < DTYPES.length; i++ ) {
list = sameKindCasts( DTYPES[ i ] );
console.log( '%s: %s', DTYPES[ i ], list.join( ', ' ) );
}@stdlib/ndarray/casting-modes: list of ndarray casting modes.@stdlib/ndarray/dtypes: list of ndarray data types.@stdlib/ndarray/safe-casts: return a list of ndarray data types to which a provided ndarray data type can be safely cast.
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.
See LICENSE.
Copyright © 2016-2022. The Stdlib Authors.
