@stdlib/ndarray-base-assert-is-allowed-data-type-cast
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!

isAllowedCast

NPM version Build Status Coverage Status

Determine whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode.

Installation

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

Usage

var isAllowedCast = require( '@stdlib/ndarray-base-assert-is-allowed-data-type-cast' );

isAllowedCast( from, to, casting )

Returns a boolean indicating whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode.

var bool = isAllowedCast( 'float32', 'float64', 'safe' );
// returns true

bool = isAllowedCast( 'float64', 'int32', 'safe' );
// returns false

The following casting modes are supported:

  • none: only allow casting between identical types.
  • equiv: allow casting between identical and byte swapped types.
  • safe: only allow "safe" casts.
  • mostly-safe: allow "safe" casts and, for floating-point data types, downcasts.
  • same-kind: allow "safe" casts and casts within the same kind (e.g., between signed integers or between floats).
  • unsafe: allow casting between all types (including between integers and floats).

Examples

var dtypes = require( '@stdlib/ndarray-dtypes' );
var modes = require( '@stdlib/ndarray-casting-modes' );
var isAllowedCast = require( '@stdlib/ndarray-base-assert-is-allowed-data-type-cast' );

var DTYPES;
var MODES;
var bool;
var dt1;
var dt2;
var i;
var j;
var k;

// Get a list of supported ndarray data types and casting modes:
DTYPES = dtypes();
MODES = modes();

// For each data type and mode, determine whether one can cast to another data type...
for ( i = 0; i < DTYPES.length; i++ ) {
    dt1 = DTYPES[ i ];
    for ( j = 0; j < DTYPES.length; j++ ) {
        dt2 = DTYPES[ j ];
        for ( k = 0; k < MODES.length; k++ ) {
            bool = isAllowedCast( dt1, dt2, MODES[ k ] );
            console.log( '%s => %s. %s: %s.', dt1, dt2, MODES[ k ], bool );
        }
    }
}

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.

Dependencies (5)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @stdlib/ndarray-base-assert-is-allowed-data-type-cast

    Homepage

    stdlib.io

    Weekly Downloads

    683

    Version

    0.2.1

    License

    Apache-2.0

    Unpacked Size

    35.9 kB

    Total Files

    14

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser