resolve

Return the enumeration constant associated with a supported BLAS diagonal type value.

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>
Did you find this page helpful?