compute-mmin
v1.0.0
Published
Computes a moving minimum over a numeric array.
Downloads
833
Maintainers
Readme
Moving Minimum
Computes a moving minimum over a numeric array.
Installation
$ npm install compute-mmin
For use in the browser, use browserify.
Usage
To use the module,
var mmin = require( 'compute-mmin' );
mmin( arr, window )
Slides a window
over a numeric array
to compute a moving minimum.
var data = [ 1, 3, 2, 5, 4 ];
mmin( data, 2 );
// returns [ 1, 2, 2, 4 ]
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 mmin = require( 'compute-mmin' );
// Simulate some data...
var data = new Array( 50 );
for ( var i = 0; i < data.length; i++ ) {
data[ i ] = Math.random() * 100;
}
// Compute the moving minimum:
var arr = mmin( 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
Copyright
Copyright © 2014. Rebekah Smith.