str2enum

Return the enumeration constant associated with a BLAS diagonal type.

Installation

npm install @stdlib/blas-base-diagonal-type-str2enum

Usage

var str2enum = require( '@stdlib/blas-base-diagonal-type-str2enum' );

str2enum( diagonal )

Return the enumeration constant associated with a BLAS diagonal-type.

var v = str2enum( 'unit' );
// returns <number>

If unable to resolve an enumeration constant, the function returns null.

var v = str2enum( '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 str2enum = require( '@stdlib/blas-base-diagonal-type-str2enum' );

var v = str2enum( 'unit' );
// returns <number>

v = str2enum( 'non-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.