@stdlib/array-nans

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!

nans

Create an array filled with NaNs and having a specified length.

Installation

npm install @stdlib/array-nans

Usage

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

nans( length[, dtype] )

Creates an array filled with NaNs and having a specified length.

var arr = nans( 2 );
// returns <Float64Array>[ NaN, NaN ]

The function recognizes 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 float64 (i.e., a typed array). To specify an alternative data type, provide a dtype argument.

var arr = nans( 2, 'float32' );
// returns <Float32Array>[ NaN, NaN ]

Notes

• For complex number arrays, 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 nans = require( '@stdlib/array-nans' );

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

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

---

See Also

• @stdlib/array-full: create a filled array having a specified length.
• @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: create an array filled with ones and having a specified length.
• @stdlib/array-zeros: create a zero-filled array having a specified length.

---

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.