compute-csum

Computes the cumulative sum of a numeric array.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
compute-csum
1.0.110 years ago10 years agoMinified + gzip package size for compute-csum in KB

Readme

csum
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependenciesdependencies-imagedependencies-url
Computes the cumulative sum of a numeric array.

Installation

$ npm install compute-csum

For use in the browser, use browserify.

Usage

To use the module,
var csum = require( 'compute-csum' );

csum( arr )

Computes the cumulative sum of a numeric array.
var data = [ 1, 2, 3, 4 ];

csum( data );
// returns [ 1, 3, 6, 10 ]

Examples

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

var data = new Array( 1000 );

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

data.sort( function sort( a, b ) {
	return a - b;
});

console.log( csum( data ) );
// returns [...]

To run the example code from the top-level application directory,
$ node ./examples/index.js

Notes

The function returns an array with a length equal to the original input array.

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.

Copyright

Copyright © 2014. Athan Reines.