Nasal Pathway Melodrama

    @stdlib/ndarray-base-buffer-dtype
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    Buffer Data Type

    NPM version Build Status Coverage Status

    Return the data type of an ndarray data buffer.

    Installation

    npm install @stdlib/ndarray-base-buffer-dtype

    Usage

    var dtype = require( '@stdlib/ndarray-base-buffer-dtype' );

    dtype( buffer )

    Returns the data type of an ndarray data buffer.

    var Float64Array = require( '@stdlib/array-float64' );
    var buf = new Float64Array( 10 );
    
    var dt = dtype( buf );
    // returns 'float64'

    If provided an ndarray data buffer having an unknown or unsupported data type, the function returns null.

    var dt = dtype( 'beep' );
    // returns null

    Examples

    var dtypes = require( '@stdlib/ndarray-dtypes' );
    var bufferCtors = require( '@stdlib/ndarray-base-buffer-ctors' );
    var isFunction = require( '@stdlib/assert-is-function' );
    var dtype = require( '@stdlib/ndarray-base-buffer-dtype' );
    
    var DTYPES;
    var ctor;
    var buf;
    var len;
    var dt;
    var i;
    
    // Get a list of supported ndarray buffer data types:
    DTYPES = dtypes();
    
    // Buffer length:
    len = 10;
    
    // For each supported data type, create a buffer and confirm its data type...
    for ( i = 0; i < DTYPES.length; i++ ) {
        ctor = bufferCtors( DTYPES[ i ] );
        if ( DTYPES[ i ] === 'binary' && isFunction( ctor.alloc ) ) {
            buf = ctor.alloc( len );
        } else {
            buf = new ctor( len );
        }
        dt = dtype( buf );
        console.log( '%s == %s => %s', DTYPES[ i ], dt, DTYPES[ i ] === dt );
    }
    
    // Try an array-like object...
    buf = {
        'length': 10
    };
    dt = dtype( buf );
    console.log( '%s == %s => %s', 'generic', dt, dt === 'generic' );

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

    Install

    npm i @stdlib/ndarray-base-buffer-dtype

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    339

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    41.6 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser