resolve

Return the enumeration constant associated with a supported ndarray data type policy value.

Usage

var resolve = require( '@stdlib/ndarray/base/output-policy-resolve-enum' );

resolve( policy )

Returns the enumeration constant associated with an ndarray data type policy value.

var str2enum = require( '@stdlib/ndarray/base/output-policy-str2enum' );

var v = resolve( 'same' );
// returns <number>

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

Examples

var resolve = require( '@stdlib/ndarray/base/output-policy-resolve-enum' );

var v = resolve( 'same' );
// returns <number>

v = resolve( 'promoted' );
// returns <number>

v = resolve( 'integer' );
// returns <number>

v = resolve( 'floating_point' );
// returns <number>

v = resolve( 'signed_integer' );
// returns <number>

v = resolve( 'unsigned_integer' );
// returns <number>

v = resolve( 'real_floating_point' );
// returns <number>

v = resolve( 'complex_floating_point' );
// returns <number>
Did you find this page helpful?