README
Same Kind Casts
Return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind".
Installation
npm install @stdlib/ndarray-same-kind-casts
Usage
var sameKindCasts = require( '@stdlib/ndarray-same-kind-casts' );
sameKindCasts( [dtype] )
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 1
If provided an unrecognized or unsupported dtype, the function returns null.
var out = sameKindCasts( 'foo' );
// returns null
Examples
var 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( ', ' ) );
}
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-2022. The Stdlib Authors.