Skip to content

dtypes

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

dtypes

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
include/stdlib/ndarray
include/stdlib/ndarray
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
manifest.json
manifest.json
 
 
package.json
package.json
 
 

README.md

Data Types

List of ndarray data types.

Usage

var dtypes = require( '@stdlib/ndarray/dtypes' );

dtypes( [kind] )

Returns a list of ndarray data type strings.

var out = dtypes();
// e.g., returns [ 'binary', 'complex32', 'complex64', 'complex128', ... ]

When not provided a data type "kind", the function returns an array containing the following data type strings:

  • binary: binary.
  • bool: boolean values.
  • complex32: half-precision complex floating-point numbers.
  • complex64: single-precision complex floating-point numbers.
  • complex128: double-precision complex floating-point numbers.
  • float16: half-precision floating-point numbers.
  • float32: single-precision floating-point numbers.
  • float64: double-precision floating-point numbers.
  • generic: values of any type.
  • int8: signed 8-bit integers.
  • int16: signed 16-bit integers.
  • int32: signed 32-bit integers.
  • uint8: unsigned 8-bit integers.
  • uint8c: unsigned clamped 8-bit integers.
  • uint16: unsigned 16-bit integers.
  • uint32: unsigned 32-bit integers.

To return the subset of data type strings belonging to a specified data type kind, provide a kind argument.

var out = dtypes( 'floating_point' );
// returns [...]

The function supports the following data type kinds:

  • floating_point: floating-point data types.
  • real_floating_point: real-valued floating-point data types.
  • complex_floating_point: complex-valued floating-point data types.
  • boolean: boolean data types.
  • integer: integer data types.
  • signed_integer: signed integer data types.
  • unsigned_integer: unsigned integer data types.
  • real: real-valued data types.
  • numeric: numeric data types.
  • typed: typed data types.
  • integer_index: integer index data types.
  • boolean_index: boolean index data types.
  • mask_index: mask index data types.
  • typed_index: typed index data types.
  • index: index data types.
  • all: all data types.

Additionally, the function supports extending the "kinds" listed above by appending an _and_generic suffix to the kind name (e.g., real_and_generic).

var out = dtypes( 'floating_point_and_generic' );
// returns [...]

dtypes.binary

Read-only property returning a data type instance representing a binary data type.

var dt = dtypes.binary;
// returns <DataType>

dtypes.bool

Read-only property returning a data type instance representing a boolean data type.

var dt = dtypes.bool;
// returns <DataType>

dtypes.complex32

Read-only property returning a data type instance representing a half-precision complex floating-point number data type.

var dt = dtypes.complex32;
// returns <DataType>

dtypes.complex64

Read-only property returning a data type instance representing a single-precision complex floating-point number data type.

var dt = dtypes.complex64;
// returns <DataType>

dtypes.complex128

Read-only property returning a data type instance representing a double-precision complex floating-point number data type.

var dt = dtypes.complex128;
// returns <DataType>

dtypes.float16

Read-only property returning a data type instance representing a half-precision real-valued floating-point number data type.

var dt = dtypes.float16;
// returns <DataType>

dtypes.float32

Read-only property returning a data type instance representing a single-precision real-valued floating-point number data type.

var dt = dtypes.float32;
// returns <DataType>

dtypes.float64

Read-only property returning a data type instance representing a double-precision real-valued floating-point number data type.

var dt = dtypes.float64;
// returns <DataType>

dtypes.generic

Read-only property returning a data type instance representing a "generic" data type.

var dt = dtypes.generic;
// returns <DataType>

dtypes.int8

Read-only property returning a data type instance representing a signed 8-bit integer data type.

var dt = dtypes.int8;
// returns <DataType>

dtypes.int16

Read-only property returning a data type instance representing a signed 16-bit integer data type.

var dt = dtypes.int16;
// returns <DataType>

dtypes.int32

Read-only property returning a data type instance representing a signed 32-bit integer data type.

var dt = dtypes.int32;
// returns <DataType>

dtypes.uint8

Read-only property returning a data type instance representing an unsigned 8-bit integer data type.

var dt = dtypes.uint8;
// returns <DataType>

dtypes.uint8c

Read-only property returning a data type instance representing an unsigned clamped 8-bit integer data type.

var dt = dtypes.uint8c;
// returns <DataType>

dtypes.uint16

Read-only property returning a data type instance representing an unsigned 16-bit integer data type.

var dt = dtypes.uint16;
// returns <DataType>

dtypes.uint32

Read-only property returning a data type instance representing an unsigned 32-bit integer data type.

var dt = dtypes.uint32;
// returns <DataType>

Examples

var contains = require( '@stdlib/array/base/assert/contains' ).factory;
var dtypes = require( '@stdlib/ndarray/dtypes' );

var isdtype = contains( dtypes() );

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

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

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

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

See Also