compute-cmax

cmax

Computes the cumulative maximum of a numeric array.

Installation

$ npm install compute-cmax

For use in the browser, use browserify.

Usage

To use the module,

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

cmax( arr )

Computes the cumulative maximum of a numeric array.

var data = [ 3, 2, 4, 3 ];
 
cmax( data );
// returns [ 3, 3, 4, 4 ]

Examples

var cmax = require( 'compute-cmax' );
 
// Simulate some data...
var data = new Array( 100 );
 
for ( var i = 0; i < data.length; i++ ) {
    data[ i ] = Math.round( Math.random()*100 );
}
 
console.log( cmax( data ) );
// returns [...]

To run the example code from the top-level application directory,

$ node ./examples/index.js

Notes

The function returns an array with a length equal to the original input array.

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. Athan Reines.