@stdlib/ndarray-base-assert-is-same-kind-data-type-cast

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isSameKindCast

Determine whether an ndarray data type can be safely cast to, or is of the same "kind" as, another ndarray data type.

Installation

npm install @stdlib/ndarray-base-assert-is-same-kind-data-type-cast

Usage

var isSameKindCast = require( '@stdlib/ndarray-base-assert-is-same-kind-data-type-cast' );

isSameKindCast( from, to )

Returns a boolean indicating whether an ndarray data type can be safely cast to, or is of the same "kind" as, another ndarray 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/ndarray-dtypes' );
var isSameKindCast = require( '@stdlib/ndarray-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.

Changelog

0.2.2 (2024-07-28)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.2.1">