Skip to content

Files

119 lines (69 loc) · 2.67 KB

File metadata and controls

119 lines (69 loc) · 2.67 KB

str2enum

Return the enumeration constant associated with a BLAS operation side.

Usage

var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );

str2enum( operation )

Returns the enumeration constant associated with a BLAS operation side.

var v = str2enum( 'left' );
// 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., LEFT == 0). Instead, the function should be used in an opaque manner.

Examples

var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );

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

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