zeros

Create a zero-filled ndarray having a specified shape and data type.

Installation

npm install @stdlib/ndarray-base-zeros

Usage

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

zeros( dtype, shape, order )

Creates a zero-filled ndarray having a specified shape and numeric data type.

var arr = zeros( '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. Must be a numeric data type or "generic".
• shape: array shape.
• order: specifies whether an ndarray is 'row-major' (C-style) or 'column-major' (Fortran-style).

Examples

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

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

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

See Also

• @stdlib/ndarray-base/ctor: base multidimensional array.
• @stdlib/ndarray-base/zeros-like: create a zero-filled ndarray having the same shape and data type as a provided ndarray.

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.