8000 GitHub - stdlib-js/array-same-kind-casts at 156a56feb6d529c5eaca6b6ae232d2dcb07d8ced
[go: up one dir, main page]

Skip to content

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

License

Notifications You must be signed in to change notification settings

stdlib-js/array-same-kind-casts

Repository files navigation

Same Kind Casts

NPM version Build Status Coverage Status

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

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

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' );

var DTYPES;
var list;
var i;

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

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

See Also


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

About

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

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published
0