NaNs
Creates a NaN-filled matrix or array.
Installation
$ npm install compute-nans
For use in the browser, use browserify.
Usage
var nans = ;
nans( dims[, opts] )
Creates a NaN-filled matrix
or array
. The dims
argument may either be a positive integer
specifying a length
or an array
of positive integers
specifying dimensions.
var out;out = ;// returns [ NaN, NaN, NaN, NaN, NaN ];out = ;// returns [ [ [NaN,NaN] ], [ [NaN,NaN] ] ]
The function accepts the following options
:
-
dtype: output data type. The following
dtypes
are accepted:float32
float64
generic
(default)
By default, the output data structure is a generic array
. To output a typed array
or matrix
, set the dtype
option.
var out;out =;// returns Float32Array( [NaN,NaN,NaN,NaN,NaN] );out =;/*[ NaN NaNNaN NaNNaN NaN ]*/
Notes:
-
Currently, for more than
2
dimensions, the function outputs a genericarray
and ignores any specifieddtype
.var out =;// returns [ [ [NaN,NaN,NaN] ], [ [NaN,NaN,NaN] ] ] -
Integer
arrays
are not supported. In JavaScript,NaN
values are only represented in floating-point storage formats (IEEE 754).
nans.compile( dims )
Compiles a function
for creating NaN-filled arrays
having specified dimensions.
var fcn out;fcn = nans;out = ;// returns [ [ [NaN,NaN,NaN] ], [ [NaN,NaN,NaN] ] ]out = ;// returns [ [ [NaN,NaN,NaN] ], [ [NaN,NaN,NaN] ] ]
Notes:
- When repeatedly creating
arrays
having the same shape, creating a customizednans
function will provide performance benefits.
Examples
var nans =out;// Plain arrays...// 1x10:out = ;// 2x1x3:out = ;// 5x5x5:out = ;// 10x5x10x20:out = ;// Typed arrays...out =;// Matrices...out =;
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015-2016. The Compute.io Authors.