Package Exports

@stdlib/array-dtypes

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/array-dtypes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Data Types

List of array data types.

Installation

npm install @stdlib/array-dtypes

Usage

var dtypes = require( '@stdlib/array-dtypes' );

dtypes()

Returns a list of array data types.

var out = dtypes();
// returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c' ]

The output array contains the following data types:

float32: single-precision floating-point numbers.
float64: double-precision floating-point numbers.
generic: values of any type.
int16: signed 16-bit integers.
int32: signed 32-bit integers.
int8: signed 8-bit integers.
uint16: unsigned 16-bit integers.
uint32: unsigned 32-bit integers.
uint8: unsigned 8-bit integers.
uint8c: unsigned clamped 8-bit integers.

Examples

var indexOf = require( '@stdlib/utils-index-of' );
var dtypes = require( '@stdlib/array-dtypes' );

var DTYPES = dtypes();
var bool;

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

bool = isdtype( 'float64' );
// returns true

bool = isdtype( 'int16' );
// returns true

bool = isdtype( 'uint8' );
// returns true

bool = isdtype( '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.

@stdlib/array-dtypes