Return the data type of an ndarray data buffer.
APACHE-2.0 License
Return the data type of an ndarray data buffer.
npm install @stdlib/ndarray-base-buffer-dtype
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var dtype = require( '@stdlib/ndarray-base-buffer-dtype' );
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
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' );
// Get a list of supported ndarray buffer data types:
var DTYPES = dtypes();
// Buffer length:
var len = 10;
// For each supported data type, create a buffer and confirm its data type...
var ctor;
var buf;
var dt;
var i;
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' );
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.