@stdlib/ndarray-base-buffer-ctors

ndarray data buffer constructors.

Usage no npm install needed!

<script type="module">
  import stdlibNdarrayBaseBufferCtors from 'https://cdn.skypack.dev/@stdlib/ndarray-base-buffer-ctors';
</script>

README

Buffer Constructors

NPM version Build Status Coverage Status dependencies

ndarray data buffer constructors.

Installation

npm install @stdlib/ndarray-base-buffer-ctors

Usage

var ctors = require( '@stdlib/ndarray-base-buffer-ctors' );

ctors( dtype )

Returns an ndarray data buffer constructor for a specified data type.

var ctor = ctors( 'float64' );
// returns <Function>

The function returns constructors for the following data types:

  • binary: binary.
  • complex64: single-precision complex floating-point numbers.
  • complex128: double-precision complex floating-point numbers.
  • 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.

If provided an unknown or unsupported data type, the function returns null.

var ctor = ctors( 'float' );
// returns null

Examples

var dtypes = require( '@stdlib/ndarray-dtypes' );
var ctors = require( '@stdlib/ndarray-base-buffer-ctors' );

var DTYPES = dtypes();
var ctor;
var i;

for ( i = 0; i < DTYPES.length; i++ ) {
    ctor = ctors( DTYPES[ i ] );
    console.log( ctor );
}

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.