zeros
Create a zero-filled ndarray having a specified shape and data type.
Usage
var zeros = require( '@stdlib/ndarray/zeros' );
zeros( shape[, options] )
Creates a zero-filled ndarray having a specified shape and data type.
var arr = zeros( [ 2, 2 ] );
// returns <ndarray>
var sh = arr.shape;
// returns [ 2, 2 ]
var dt = arr.dtype;
// returns 'float64'
The specified output ndarray shape may be either an array-like object or an integer value.
var arr = zeros( 2 );
// returns <ndarray>
var sh = arr.shape;
// returns [ 2 ]
var dt = arr.dtype;
// returns 'float64'
The function accepts the following options:
- dtype: underlying data type. Must be a numeric data type or "generic". Default:
'float64'. - order: specifies whether an ndarray is
'row-major'(C-style) or'column-major'(Fortran-style). Default:'row-major'. - mode: specifies how to handle indices which exceed array dimensions (see
ndarray). Default:'throw'. - submode: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions (see
ndarray). If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default:[ options.mode ]. - readonly:
booleanindicating whether an array should be read-only. Default:false.
By default, the function returns an ndarray having a float64 data type. To specify an alternative data type, provide a dtype option.
var arr = zeros( [ 2, 2 ], {
'dtype': 'float32'
});
// returns <ndarray>
var sh = arr.shape;
// returns [ 2, 2 ]
var dt = arr.dtype;
// returns 'float32'
Examples
var dtypes = require( '@stdlib/ndarray/dtypes' );
var zeros = require( '@stdlib/ndarray/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( [ 2, 2 ], {
'dtype': dt[ i ]
});
console.log( arr.data );
}