time-to-botec/js/node_modules/@stdlib/ndarray/safe-casts

Safe Casts

Return a list of ndarray data types to which a provided ndarray data type can be safely cast.

Usage

var safeCasts = require( '@stdlib/ndarray/safe-casts' );

safeCasts( [dtype] )

If provided a dtype argument, returns a list of ndarray data types to which a provided ndarray data type can be safely cast.

var out = safeCasts( 'float32' );
// e.g., returns [ 'float32', 'float64', ... ]

If not provided a dtype argument, the function returns a casting table.

var out = safeCasts();
// returns {...}

var f32 = out[ 'float32' ];
// returns {...}

var v = f32[ 'float64' ];
// returns 1

If provided an unrecognized or unsupported dtype, the function returns null.

var out = safeCasts( 'foo' );
// returns null

Examples

var dtypes = require( '@stdlib/ndarray/dtypes' );
var safeCasts = require( '@stdlib/ndarray/safe-casts' );

var DTYPES;
var list;
var i;

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

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