Package Exports

compute-mmax

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (compute-mmax) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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 = require( 'compute-mmax' );

mmax( arr, window )

Slides a window over a numeric array to compute a moving maximum.

var data = [ 1, 3, 2, 5, 4 ];

mmax( data, 2 );
// 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 = require( 'compute-mmax' );

// Simulate some data...
var data = new Array( 50 );

for ( var i = 0; i < data.length; i++ ) {
    data[ i ] = Math.random() * 100;
}

// Compute the moving maximum:
var arr = mmax( data, 7 );

console.log( arr.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

MIT license.

compute-mmax