compute-wmean

wmean

Computes a weighted mean over an array of values.

Installation

$ npm install compute-wmean

For use in the browser, use browserify.

Usage

To use the module,

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

Examples

var data = new Array( 100 ),
    weights = new Array( 100 );
 
for ( var i = 0; i < data.length; i++ ) {
    data[ i ] = Math.random()*100;
    weights[ i ] = Math.random();
}
 
console.log( wmean( data, weights ) );

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,

$ open reports/coverage/lcov-report/index.html

License

MIT license.

---

Copyright

Copyright © 2014. Athan Reines.