Bytes per Element

Return the number of bytes per element provided an underlying array data type.

Installation

npm install @stdlib/ndarray-base-bytes-per-element

Usage

var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );

bytesPerElement( dtype )

Returns the number of bytes per element provided an underlying array data type.

var nbytes = bytesPerElement( 'float64' );
// returns 8

nbytes = bytesPerElement( 'generic' );
// returns null

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

var nbytes = bytesPerElement( 'foobar' );
// returns null

Examples

var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );

var dtypes;
var nbytes;
var i;

dtypes = [
    'float64',
    'float32',
    'int8',
    'uint8',
    'uint8c',
    'int16',
    'uint16',
    'int32',
    'uint32',
    'binary',
    'generic',
    'foobar'
];

for ( i = 0; i < dtypes.length; i++ ) {
    nbytes = bytesPerElement( dtypes[ i ] );
    nbytes = ( nbytes ) ? nbytes+' bytes' : 'null';
    console.log( '%s => %s', dtypes[ i ], nbytes );
}

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.