stdlib-js/ndarray-dtype-ctorPublic

NotificationsYou must be signed in to change notification settings
Fork0
Star0

Data type constructor.

License

Apache-2.0 license

0 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 33 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!

DataType

Data type constructor.

Usage

importDataTypefrom'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-dtype-ctor@deno/mod.js';

DataType( value[, options] )

Returns a data type instance.

vardt=newDataType('float64');// returns <DataType>

The constructor supports the following parameters:

value: data type value. Must be either a supporteddata type string, astruct constructor, or another data type instance.
options: constructor options (optional).

The constructor supports the following options:

description: data type description.

Properties

DataType.prototype.alignment

Alignment (in bytes) for the data type.

vardt=newDataType('float64');// returns <DataType>varv=dt.alignment;// returns 8

If a data type does not have a known alignment, the returned value is-1.

DataType.prototype.byteLength

Size (in bytes) for the data type.

vardt=newDataType('float64');// returns <DataType>varv=dt.byteLength;// returns 8

If a data type does not have a known size, the returned value is-1.

DataType.prototype.byteOrder

Data type byte order.

vardt=newDataType('float64');// returns <DataType>varv=dt.byteOrder;// returns 'host'

The byte order may be one of the following values:

host: host platform byte order.
little-endian: little-endian byte order.
big-endian: big-endian byte order.

DataType.prototype.char

Single letter character abbreviation for the data type.

vardt=newDataType('float64');// returns <DataType>varv=dt.char;// returns 'd'

If a data type does not have a corresponding single letter character abbreviation, the returned value is an empty string.

DataType.prototype.description

Data type description.

vardt=newDataType('float64');// returns <DataType>varv=dt.description;// returns '...'

If a data type does not have an associated description, the returned value is an empty string.

DataType.prototype.enum

Enumeration constant for the data type.

vardt=newDataType('float64');// returns <DataType>varv=dt.enum;// returns <number>

If a data type does not have a corresponding known enumeration constant, the returned value is-1.

Note: enumeration constants should be treated asopaque values. One shouldnot assume that a data type has a specific enumeration constant value.

DataType.prototype.value

Raw (original) data type value.

vardt=newDataType('float64');// returns <DataType>varv=dt.value;// returns 'float64'

Methods

DataType.prototype.toJSON()

Returns aJSON representation of aDataType instance.

vardt=newDataType('float64');// returns <DataType>varo=dt.toJSON();// e.g., returns { 'type': 'DataType', 'value': 'float64', 'byteOrder': 'host', ... }

JSON.stringify() implicitly calls this method when stringifying aDataType instance.

DataType.prototype.toString()

Returns a string representation of aDataType instance.

vardt=newDataType('float64');// returns <DataType>varstr=dt.toString();// returns 'float64'

DataType.prototype.valueOf()

Converts aDataType instance to a primitive value.

vardt=newDataType('float64');// returns <DataType>varstr=dt.valueOf();// returns 'float64'

This method returns the same value as#.toString().

Examples

importDataTypefrom'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-dtype-ctor@deno/mod.js';vardt=newDataType('complex128');console.log('type: %s',typeofdt);// => 'type: object'console.log('alignment: %d',dt.alignment);// => 'alignment: 8'console.log('byteLength: %d',dt.byteLength);// => 'byteLength: 16'console.log('byteOrder: %s',dt.byteOrder);// => 'byteOrder: host'console.log('char: %s',dt.char);// => 'char: z'console.log('JSON: %s',JSON.stringify(dt));// e.g., => 'JSON: {"type": "DataType","value":"complex128","byteOrder":"host",...}'

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.