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

    0.0.5 • Public • Published

    Safe Casts

    NPM version Build Status Coverage Status dependencies

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

    Installation

    npm install @stdlib/array-safe-casts

    Usage

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

    safeCasts( [dtype] )

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

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

    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/array-dtypes' );
    var safeCasts = require( '@stdlib/array-safe-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 safely cast...
    for ( i = 0; i < DTYPES.length; i++ ) {
        list = safeCasts( DTYPES[ i ] );
        console.log( '%s: %s', DTYPES[ i ], list.join( ', ' ) );
    }

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

    Install

    npm i @stdlib/array-safe-casts

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    1

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    39.4 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser