Package Exports

@stdlib/array-nans-like
@stdlib/array-nans-like/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/array-nans-like) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

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

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.

@stdlib/array-nans-like