@stdlib/array-same-kind-casts

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!

Same Kind Casts

Return a list of array data types to which a provided array data type can be safely cast or cast within the same "kind".

Installation

npm install @stdlib/array-same-kind-casts

Usage

var sameKindCasts = require( '@stdlib/array-same-kind-casts' );

sameKindCasts( [dtype] )

If provided a dtype argument, returns a list of array data types to which a provided array 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', 'complex64', 'complex128', 'generic' ]

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/array-dtypes' );
var sameKindCasts = require( '@stdlib/array-same-kind-casts' );

// Get the list of supported array data types:
var DTYPES = dtypes();

// Print the list of array data types to which a data type can be cast...
var list;
var i;
for ( i = 0; i < DTYPES.length; i++ ) {
    list = sameKindCasts( DTYPES[ i ] );
    console.log( '%s: %s', DTYPES[ i ], list.join( ', ' ) );
}

---

See Also

• @stdlib/array-convert: convert an array to an array of a different data type.
• @stdlib/array-convert-same: convert an array to the same data type as a second input array.
• @stdlib/array-dtypes: list of array data types.
• @stdlib/array-safe-casts: return a list of array data types to which a provided array data type can be safely cast.
• @stdlib/ndarray-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.

---

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.