empty

Create an uninitialized ndarray having a specified shape and data type.

Installation

npm install @stdlib/ndarray-base-empty

Alternatively,

To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
If you are using Deno, visit the deno branch (see README for usage intructions).
For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

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

empty( dtype, shape, order )

Creates an uninitialized ndarray having a specified shape and data type.

var arr = empty( 'float64', [ 2, 2 ], 'row-major' );
// returns <ndarray>

var sh = arr.shape;
// returns [ 2, 2 ]

var dt = arr.dtype;
// returns 'float64'

The function accepts the following arguments:

dtype: underlying data type.
shape: array shape.
order: specifies whether an ndarray is 'row-major' (C-style) or 'column-major' (Fortran-style).

Notes

If dtype is 'generic', the function always returns a zero-filled array.
For returned ndarrays whose underlying memory is not initialized, memory contents are unknown and may contain sensitive data.

Examples

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

// Get a list of data types:
var dt = dtypes();

// Generate uninitialized arrays...
var arr;
var i;
for ( i = 0; i < dt.length; i++ ) {
    arr = empty( dt[ i ], [ 2, 2 ], 'row-major' );
    console.log( arr.data );
}

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.