@stdlib/blas-base-diagonal-type-resolve-enum
v0.0.1
Published
Return the enumeration constant associated with a supported BLAS diagonal type value.
Downloads
9
Readme
resolve
Return the enumeration constant associated with a supported BLAS diagonal type value.
Installation
npm install @stdlib/blas-base-diagonal-type-resolve-enum
Usage
var resolve = require( '@stdlib/blas-base-diagonal-type-resolve-enum' );
resolve( value )
Returns the enumeration constant associated with a BLAS diagonal type value.
var str2enum = require( '@stdlib/blas-base-diagonal-type-str2enum' );
var v = resolve( 'non-unit' );
// returns <number>
v = resolve( str2enum( 'non-unit' ) );
// returns <number>
If unable to resolve an enumeration constant, the function returns null
.
var v = resolve( 'beep' );
// returns null
Notes
- Downstream consumers of this function should not rely on specific integer values (e.g.,
UNIT == 0
). Instead, the function should be used in an opaque manner.
Examples
var resolve = require( '@stdlib/blas-base-diagonal-type-resolve-enum' );
var v = resolve( 'non-unit' );
// returns <number>
v = resolve( 'unit' );
// returns <number>
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.