@stdlib/array-zeros-like

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

zerosLike

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

Installation

npm install @stdlib/array-zeros-like

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 );
}

---

See Also

• @stdlib/array-empty-like: create an uninitialized array having the same length and data type as a provided array.
• @stdlib/array-full-like: create a filled array having the same length and data type as a provided array.
• @stdlib/array-nans-like: create an array filled with NaNs and having the same length and data type as a provided array.
• @stdlib/array-ones-like: create an array filled with ones and having the same length and data type as a provided array.
• @stdlib/array-zeros: create a zero-filled array having a specified length.
• @stdlib/ndarray-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.