@stdlib/ndarray-output-dtype-policies

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Policies

List of output ndarray data type policies.

Installation

npm install @stdlib/ndarray-output-dtype-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

---

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.