zerosLike

Create a zero-filled array having the same length and data type as a provided array.

Usage

var zerosLike = require( '@stdlib/array/zeros-like' );

zerosLike( x[, dtype] )

Creates a zero-filled array having the same length and data type as a provided array x.

var x = [ 1, 2, 3, 4, 5 ];

var arr = zerosLike( x );
// returns [ 0, 0, 0, 0, 0 ]

The function supports the following data types:

  • float64: double-precision floating-point numbers (IEEE 754)
  • float32: single-precision floating-point numbers (IEEE 754)
  • complex128: double-precision complex floating-point numbers
  • complex64: single-precision complex floating-point numbers
  • int32: 32-bit two's complement signed integers
  • uint32: 32-bit unsigned integers
  • int16: 16-bit two's complement signed integers
  • uint16: 16-bit unsigned integers
  • int8: 8-bit two's complement signed integers
  • uint8: 8-bit unsigned integers
  • uint8c: 8-bit unsigned integers clamped to 0-255
  • generic: generic JavaScript values

By default, the output array data type is inferred from the provided array x. To return an array having a different data type, provide a dtype argument.

var x = [ 0, 0 ];

var arr = zerosLike( x, 'int32' );
// returns <Int32Array>[ 0, 0 ]

Examples

var dtypes = require( '@stdlib/array/dtypes' );
var zeros = require( '@stdlib/array/zeros' );
var zerosLike = require( '@stdlib/array/zeros-like' );

// Create a zero-filled array:
var x = zeros( 4, 'complex128' );

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

// Generate additional zero-filled arrays...
var y;
var i;
for ( i = 0; i < dt.length; i++ ) {
    y = zerosLike( x, dt[ i ] );
    console.log( y );
}
Did you find this page helpful?