compute-sum

Computes the sum.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
compute-sum
402.0.08 years ago8 years agoMinified + gzip package size for compute-sum in KB

Readme

Sum
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependenciesdependencies-imagedependencies-url
Computes the sum.

The sum is defined as
<img src="https://cdn.rawgit.com/compute-io/sum/f6e6f6cd4c7b9355ad0613bc18b896f62dccc359/docs/img/eqn.svg" alt="Equation for summation.">
<br>

where x_0, x_1,...,x_{N-1} are individual data values and N is the total number of values in the data set.

Installation

$ npm install compute-sum

For use in the browser, use browserify.

Usage

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

sum( x, options )

Computes the sum of the elements in x. x may be either an array, typed array, or matrix.
var data = [ 1, 2, 3, 4 ];

var s = sum( data );
// returns 10

data = new Int8Array( data );
s = sum( data );
// returns 10

For non-numeric arrays, provide an accessor function for accessing array values.
var arr = [
	{'x':1},
	{'x':2},
	{'x':3},
	{'x':4}
];

function getValue( d ) {
	return d.x;
}

var value = sum( arr, {
	'accessor': getValue
});
// returns 10

If provided a matrix, the function accepts the following options:
  • dim: dimension along which to compute the sum. Default: 2 (along the columns).
  • dtype: output matrix data type. Default: float64.

By default, the function computes the sum along the columns (dim=2).
var matrix = require( 'dstructs-matrix' ),
	data,
	mat,
	s,
	i;

data = new Int8Array( 9 );
for ( i = 0; i < data.length; i++ ) {
	data[ i ] = i + 1;
}
mat = matrix( data, [3,3], 'int8' );
/*
	[  1 2 3
	   4 5 6
	   7 8 9 ]
*/

s = sum( mat );
/*
	[  6
	   15
	   24 ]
*/

To compute the sum along the rows, set the dim option to 1.
s = sum( mat, {
	'dim': 1
});
/*
	[ 12 15 18 ]
*/

By default, the output matrix data type is float64. To specify a different output data type, set the dtype option.
s = sum( mat, {
	'dim': 1,
	'dtype': 'uint8'
});
/*
	[ 12 15 18 ]
*/

var dtype = p.dtype;
// returns 'uint8'

If provided a matrix having either dimension equal to 1, the function treats the matrix as a typed array and returns a numeric value.
data = [ 2, 4, 5 ];

// Row vector:
mat = matrix( new Int8Array( data ), [1,3], 'int8' );
s = sum( mat );
// returns 11

// Column vector:
mat = matrix( new Int8Array( data ), [3,1], 'int8' );
s = sum( mat );
// returns 11

If provided an empty array, typed array, or matrix, the function returns the empty sum which is equal to 0.
s = sum( [] );
// returns 0

s = sum( new Int8Array( [] ) );
// returns 0

s = sum( matrix( [0,0] ) );
// returns 0

s = sum( matrix( [0,10] ) );
// returns 0

s = sum( matrix( [10,0] ) );
// returns 0

Examples

var matrix = require( 'dstructs-matrix' ),
	sum = require( 'compute-sum' );

var data,
	mat,
	s,
	i;

// Plain arrays...
var data = new Array( 1000 );
for ( var i = 0; i < data.length; i++ ) {
	data[ i ] = Math.random() * 100;
}
s = sum( data );

// Object arrays (accessors)...
function getValue( d ) {
	return d.x;
}
for ( i = 0; i < data.length; i++ ) {
	data[ i ] = {
		'x': data[ i ]
	};
}
s = sum( data, {
	'accessor': getValue
});

// Typed arrays...
data = new Int32Array( 1000 );
for ( i = 0; i < data.length; i++ ) {
	data[ i ] = Math.random() * 100;
}
s = sum( data );

// Matrices (along rows)...
mat = matrix( data, [100,10], 'int32' );
s = sum( mat, {
	'dim': 1
});

// Matrices (along columns)...
s = sum( mat, {
	'dim': 2
});

// Matrices (custom output data type)...
s = sum( mat, {
	'dtype': 'uint8'
});

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.

Copyright

Copyright © 2014-2015. The Compute.io Authors.