Package Exports
- compute-mmean
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-mmean) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Moving Mean
Computes a moving arithmetic mean (sliding window average) over a numeric array.
Installation
$ npm install compute-mmean
For use in the browser, use browserify.
Usage
To use the module,
var mmean = require( 'compute-mmean' );
mmean( arr, window )
Slides a window
over a numeric array
to compute a moving mean.
var data = [ 1, 2, 3, 4, 5 ];
mmean( data, 2 );
// returns [ 1.5, 2.5, 3.5, 4.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 mmean = require( 'compute-mmean' );
// Simulate some data...
var data = new Array( 50 );
for ( var i = 0; i < data.length; i++ ) {
data[ i ] = Math.random() * 100;
}
// Compute the moving mean:
var arr = mmean( 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.