Package Exports

compute-add

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-add) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Add

Computes an element-wise addition of a numeric array.

Installation

$ npm install compute-add

For use in the browser, use browserify.

Usage

To use the module,

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

add( arr, x )

Computes an element-wise addition of an input array. x may be either an array of equal length or a scalar.

add( [ 2, 1, 4, 2 ], 1 );
// returns [ 3, 2, 5, 3 ]

add( [ 2, 1, 4, 2 ], [ 1, 2, 3, 3 ] );
// returns [ 3, 3, 7, 5 ]

Examples

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

// Simulate some data...
var data = new Array( 100 );

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

add( data, 10 );

console.log( data.join( '\n' ) );

To run the example code from the top-level application directory,

$ node ./examples/index.js

Notes

This function mutates the input array. If mutation is undesired,

var data = [ 1, 2, 3, 4 ],
    copy = data.slice();

add( copy, 3.14 );

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.

compute-add