@stdlib/ndarray-base-assert-is-safe-data-type-cast
v0.2.2
Published
Determine if an ndarray data type can be safely cast to another ndarray data type.
Downloads
3,668
Readme
isSafeCast
Determine whether an ndarray data type can be safely cast to another ndarray data type.
Installation
npm install @stdlib/ndarray-base-assert-is-safe-data-type-cast
Usage
var isSafeCast = require( '@stdlib/ndarray-base-assert-is-safe-data-type-cast' );
isSafeCast( from, to )
Returns a boolean
indicating whether an ndarray data type can be safely cast to another ndarray data type.
var bool = isSafeCast( 'float32', 'float64' );
// returns true
bool = isSafeCast( 'float64', 'int32' );
// returns false
Examples
var cartesianSquare = require( '@stdlib/array-cartesian-square' );
var dtypes = require( '@stdlib/ndarray-dtypes' );
var isSafeCast = require( '@stdlib/ndarray-base-assert-is-safe-data-type-cast' );
// Generate a list of dtype pairs:
var dt = cartesianSquare( dtypes() );
// For each data type pair, determine whether one can safely cast from one data type to another...
var i;
for ( i = 0; i < dt.length; i++ ) {
console.log( '%s. Safe? %s.', dt[i].join( ' => ' ), isSafeCast.apply( null, dt[i] ) );
}
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-2024. The Stdlib Authors.