Policies

List of output ndarray data type policies.

Usage

var policies = require( '@stdlib/ndarray/output-dtype-policies' );

policies()

Returns a list of ndarray data type policies.

var out = policies();
// e.g., returns [ 'same', 'promoted', ... ]

The output array contains the following data type policies:

same: return the same data type.
promoted: return a promoted data type.
bool: return a boolean data type.
signed_integer: return a signed integer data type.
unsigned_integer: return an unsigned integer data type.
integer: return an integer data type (i.e., either signed or unsigned).
floating_point: return a floating-point data type (i.e., either real-valued or complex-valued).
real_floating_point: return a real-valued floating-point data type.
complex_floating_point: return a complex-valued floating-point data type.
real: return a real-valued data type.
numeric: return a numeric data type.
default: return the default data type.

Examples

var indexOf = require( '@stdlib/utils/index-of' );
var policies = require( '@stdlib/ndarray/output-dtype-policies' );

var POLICIES = policies();

function isPolicy( str ) {
    if ( indexOf( POLICIES, str ) === -1 ) {
        return false;
    }
    return true;
}

var bool = isPolicy( 'same' );
// returns true

bool = isPolicy( 'real_floating_point' );
// returns true

bool = isPolicy( 'promoted' );
// returns true

bool = isPolicy( 'beep' );
// returns false