@stdlib/ndarray-safe-casts
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

Safe Casts

NPM version Build Status Coverage Status

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

Installation

npm install @stdlib/ndarray-safe-casts

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( ', ' ) );
}

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-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/ndarray-safe-casts

Homepage

stdlib.io

Weekly Downloads

774

Version

0.2.1

License

Apache-2.0

Unpacked Size

53.9 kB

Total Files

14

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser