dtypeDesc

Return the description for a specified data type.

Installation

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

Usage

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

dtypeDesc( [dtype] )

Returns the description for a specified data type.

var desc = dtypeDesc( 'float64' );
// returns '...'

desc = dtypeDesc( 'generic' );
// returns '...'

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

var desc = dtypeDesc( 'foobar' );
// returns null

If not provided a data type value, the function returns an object mapping data type strings to descriptions.

var obj = dtypeDesc();
// returns {...}

Examples

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

var dtypes;
var desc;
var i;

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

for ( i = 0; i < dtypes.length; i++ ) {
    desc = dtypeDesc( dtypes[ i ] );
    console.log( '%s: %s', dtypes[ i ], desc );
}

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.