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!

nansLike

Create an array filled with NaNs and having the same length and data type as a provided array.

Installation

npm install @stdlib/array-nans-like

Alternatively,

To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
If you are using Deno, visit the deno branch (see README for usage intructions).
For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var nansLike = require( '@stdlib/array-nans-like' );

nansLike( x[, dtype] )

Creates an array filled with NaNs and having the same length and data type as a provided array x.

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

var arr = nansLike( x );
// returns [ NaN, NaN, NaN, NaN, NaN ]

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
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 = nansLike( x, 'float32' );
// returns <Float32Array>[ NaN, NaN ]

Notes

If the output array has a complex number data type, each element of the returned array has a real component equal to NaN and an imaginary component equal to NaN.

Examples

var dtypes = require( '@stdlib/array-typed-float-dtypes' );
var zeros = require( '@stdlib/array-zeros' );
var nansLike = require( '@stdlib/array-nans-like' );

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

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

// Generate filled arrays...
var y;
var i;
for ( i = 0; i < dt.length; i++ ) {
    y = nansLike( x, dt[ i ] );
    console.log( y );
}

See Also

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

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-2025. The Stdlib Authors.

Uh oh!