compute-range

Computes the arithmetic range of an array.


Keywords
compute.io, compute, computation, statistics, stats, mathematics, math, range, min, max, minimum, maximum, arithmetic, array, numeric array
License
MIT
Install
npm install compute-range@1.0.0

Documentation

Range

NPM version Build Status Coverage Status Dependencies

Computes the arithmetic range of an array.

Installation

$ npm install compute-range

For use in the browser, use browserify.

Usage

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

range( arr[, accessor] )

Computes the arithmetic range of an array. For primitive number arrays,

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

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

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

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

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

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

Notes

  • if provided an empty array, the function returns null.
  • the first value of the returned array is always the minimum value and the second value is always the maximum value.

Examples

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

var data = new Array( 100 );
for ( var i = 0; i < data.length; i++ ) {
	data[ i ] = Math.random() * 100;
}
console.log( range( 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 © 2014-2015. Athan Reines.