Contiguous Data Buffer

Create a zero-filled contiguous linear ndarray data buffer.

Installation

npm install @stdlib/ndarray-base-buffer

Usage

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

buffer( dtype, size )

Returns a zero-filled contiguous linear ndarray data buffer.

var buf = buffer( 'float64', 3 );
// returns <Float64Array>[ 0.0, 0.0, 0.0 ]

The function supports 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 buf = buffer( 'float', 3 );
// returns null

Examples

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

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

for ( i = 0; i < DTYPES.length; i++ ) {
    buf = buffer( DTYPES[ i ], 10 );
    console.log( buf );
}

---

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.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.