zerosLike
Create a zero-filled ndarray having the same shape and data type as a provided ndarray.
Usage
var zerosLike = require( '@stdlib/ndarray/zeros-like' );
zerosLike( x[, options] )
Creates a zero-filled ndarray having the same shape and data type as a provided ndarray.
var zeros = require( '@stdlib/ndarray/zeros' );
var x = zeros( [ 2, 2 ] );
// returns <ndarray>
var y = zerosLike( x );
// returns <ndarray>
var sh = y.shape;
// returns [ 2, 2 ]
var dt = y.dtype;
// returns 'float64'
The function supports the following options:
- dtype: output ndarray data type. Must be a numeric data type or "generic". Overrides the input ndarray's inferred data type.
- shape: output ndarray shape. Overrides the input ndarray's inferred shape.
- order: specifies whether the output ndarray should be
'row-major'(C-style) or'column-major'(Fortran-style). Overrides the input ndarray's inferred order. - 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.
To override either the dtype, shape, or order, specify the corresponding option. For example, to override the inferred data type,
var zeros = require( '@stdlib/ndarray/zeros' );
var x = zeros( [ 2, 2 ] );
// returns <ndarray>
var dt = x.dtype;
// returns 'float64'
var y = zerosLike( x, {
'dtype': 'int32'
});
// returns <ndarray>
var sh = y.shape;
// returns [ 2, 2 ]
dt = y.dtype;
// returns 'int32'
Examples
var dtypes = require( '@stdlib/ndarray/dtypes' );
var zeros = require( '@stdlib/ndarray/zeros' );
var zerosLike = require( '@stdlib/ndarray/zeros-like' );
// Get a list of data types:
var dt = dtypes( 'numeric' );
// Generate zero-filled arrays...
var x;
var y;
var i;
for ( i = 0; i < dt.length; i++ ) {
x = zeros( [ 2, 2 ], {
'dtype': dt[ i ]
});
y = zerosLike( x );
console.log( y.data );
}