@stdlib/array-base-assert-is-same-kind-data-type-cast
v0.3.1
Published
Determine if an array data type can be safely cast to, or is of the same kind as, another array data type.
Downloads
32
Readme
isSameKindCast
Determine whether an array data type can be safely cast to, or is of the same "kind" as, another array data type.
Installation
npm install @stdlib/array-base-assert-is-same-kind-data-type-cast
Usage
var isSameKindCast = require( '@stdlib/array-base-assert-is-same-kind-data-type-cast' );
isSameKindCast( from, to )
Returns a boolean
indicating whether an array data type can be safely cast to, or is of the same "kind" as, another array data type (e.g., casting between signed integers or between floats).
var bool = isSameKindCast( 'float32', 'float64' );
// returns true
bool = isSameKindCast( 'uint16', 'int16' );
// returns false
Examples
var cartesianSquare = require( '@stdlib/array-cartesian-square' );
var dtypes = require( '@stdlib/array-dtypes' );
var isSameKindCast = require( '@stdlib/array-base-assert-is-same-kind-data-type-cast' );
// Generate a list of dtype pairs:
var dt = cartesianSquare( dtypes() );
// For each data type pair, determine whether one can cast from one data type to another...
var i;
for ( i = 0; i < dt.length; i++ ) {
console.log( '%s. Allowed cast? %s.', dt[i].join( ' => ' ), isSameKindCast.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.