Incrspace
Generates a linearly spaced numeric array using a provided increment.
Installation
$ npm install compute-incrspace
For use in the browser, use browserify.
Usage
var incrspace = require( 'compute-incrspace' );
incrspace( start, stop[, increment] )
Generates a linearly spaced numeric array
. If an increment
is not provided, the default increment
is 1
.
var arr = incrspace( 0, 11, 2 );
// returns [ 0, 2, 4, 6, 8, 10 ]
Notes
The output array
is guaranteed to include the start
value but does not include the stop
value. Beware that values subsequent to the start
value are subject to floating point errors. Hence,
var arr = incrspace( 0.1, 0.5, 0.2 );
// returns [ 0, ~0.3 ]
where arr[1]
is only guaranteed to be approximately equal to 0.3
.
If you desire more control over element precision, consider using compute-roundn:
var roundn = require( 'compute-roundn' );
// Create an array subject to floating point errors:
var arr = incrspace( 0, 1.01, 0.02 );
// Round each value to the nearest hundredth:
roundn( arr, -2 );
console.log( arr.join( '\n' ) );
This function is similar to compute-linspace.
Examples
var incrspace = require( 'compute-incrspace' ),
out;
// Default behavior:
out = incrspace( 0, 10 );
console.log( out.join( '\n' ) );
// Specify increment:
out = incrspace( 0, 10, 2 );
console.log( out.join( '\n' ) );
out = incrspace( 0, 11, 2 );
console.log( out.join( '\n' ) );
// Create an array using a negative increment:
out = incrspace( 10, 0, -2 );
console.log( out.join( '\n' ) );
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 © 2014-2015. Athan Reines.