@stdlib/ndarray-base-dtype-enums
v0.1.1
Published
Return an object mapping supported data type strings to enumeration constants.
Readme
Enumeration Constants
Return an object mapping supported data type strings to enumeration constants.
Installation
npm install @stdlib/ndarray-base-dtype-enumsUsage
var dtypeEnums = require( '@stdlib/ndarray-base-dtype-enums' );dtypeEnums()
Returns an object mapping supported data type strings to enumeration constants.
var out = dtypeEnums();
// {...}Notes
- Downstream consumers of a returned mapping should not rely on specific integer values (e.g.,
int8 == 0). Instead, the object should be used in an opaque manner. - The main purpose of this function is JavaScript and C inter-operation of ndarray objects.
Examples
var dtypeStrings = require( '@stdlib/ndarray-base-dtype-strings' );
var dtypeEnums = require( '@stdlib/ndarray-base-dtype-enums' );
var dt = dtypeStrings();
// returns [...]
var enums = dtypeEnums();
// returns {...}
var i;
for ( i = 0; i < dt.length; i++ ) {
console.log( '%s => %d', dt[ i ], enums[ dt[ i ] ] );
}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-2026. The Stdlib Authors.
