Moving Maximum
Computes a moving maximum over a numeric array.
Installation
$ npm install compute-mmax
For use in the browser, use browserify.
Usage
To use the module,
var mmax = ;
mmax( arr, window )
Slides a window
over a numeric array
to compute a moving maximum.
var data = 1 3 2 5 4 ;;// returns [ 3, 3, 5, 5 ]
Note: the returned array
has length L - W + 1
, where L
is the length of the input array
and W
is the window
size.
Examples
var mmax = ;// Simulate some data...var data = 50 ;for var i = 0; i < datalength; i++data i = Math * 100;// Compute the moving maximum:var arr = ;console;
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. Rebekah Smith.