stdlib-js/ndarray-dtypesPublic

NotificationsYou must be signed in to change notification settings
Fork0
Star2

List of ndarray data types.

License

Apache-2.0 license

2 stars 0 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 287 Commits
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
NOTICE		NOTICE
README.md		README.md
mod.d.ts		mod.d.ts
mod.js		mod.js
mod.js.map		mod.js.map
package.json		package.json
stats.html		stats.html

Repository files navigation

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

Data Types

List of ndarray data types.

Usage

importdtypesfrom'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-dtypes@deno/mod.js';

dtypes( [kind] )

Returns a list of ndarray data type strings.

varout=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 akind argument.

varout=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).

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

dtypes.binary

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

vardt=dtypes.binary;// returns <DataType>

dtypes.bool

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

vardt=dtypes.bool;// returns <DataType>

dtypes.complex32

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

vardt=dtypes.complex32;// returns <DataType>

dtypes.complex64

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

vardt=dtypes.complex64;// returns <DataType>

dtypes.complex128

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

vardt=dtypes.complex128;// returns <DataType>

dtypes.float16

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

vardt=dtypes.float16;// returns <DataType>

dtypes.float32

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

vardt=dtypes.float32;// returns <DataType>

dtypes.float64

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

vardt=dtypes.float64;// returns <DataType>

dtypes.generic

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

vardt=dtypes.generic;// returns <DataType>

dtypes.int8

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

vardt=dtypes.int8;// returns <DataType>

dtypes.int16

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

vardt=dtypes.int16;// returns <DataType>

dtypes.int32

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

vardt=dtypes.int32;// returns <DataType>

dtypes.uint8

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

vardt=dtypes.uint8;// returns <DataType>

dtypes.uint8c

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

vardt=dtypes.uint8c;// returns <DataType>

dtypes.uint16

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

vardt=dtypes.uint16;// returns <DataType>

dtypes.uint32

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

vardt=dtypes.uint32;// returns <DataType>

Examples

varcontains=require('https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains').factory;importdtypesfrom'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-dtypes@deno/mod.js';varisdtype=contains(dtypes());varbool=isdtype('float64');// returns truebool=isdtype('int16');// returns truebool=isdtype('uint8');// returns truebool=isdtype('beep');// returns false

Notice

This package is part ofstdlib, a standard library 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 developstdlib, see the main projectrepository.