time-to-botec/js/node_modules/@stdlib/ndarray/base/bytes-per-element/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.9 KiB

Bytes per Element

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

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 );
}