compute-nanrange v1.0.0

nanrange

Computes the arithmetic range of an array ignoring non-numeric values.

Installation

$ npm install compute-nanrange

For use in the browser, use browserify.

Usage

var nanrange = require( 'compute-nanrange' );

nanrange( arr, accessor )

Computes the arithmetic range of an array ignoring non-numeric values. For primitive arrays,

var arr = [ 2, null, 3, 4, null, 1 ];

var r = range( arr );
// returns [1,4]

For object arrays, provide an accessor function for accessing array values

var arr = [
	[1,2],
	[2,null],
	[3,3],
	[4,4],
	[5,null],
	[6,1]
];

function getValue( d ) {
	return d[ 1 ];
}

var r = range( arr, getValue );
// returns [1,4]

Note: if an input array does not contain any numeric values, the function returns null.

Examples

var nanrange = require( 'compute-nanrange' );

var data = new Array( 100 );
for ( var i = 0; i < data.length; i++ ) {
	if ( i % 2 === 0 ){
		data[ i ] = null;
	} else {
		data[ i ] = Math.random()*100;
	}
}
console.log( nanrange( data ) );

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

MIT license.

Copyright

Copyright © 2015. Philipp Burckhardt.