compute-max

Computes the maximum value of a numeric array.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
compute-max
521.0.18 years ago8 years agoMinified + gzip package size for compute-max in KB

Readme

Max
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependenciesdependencies-imagedependencies-url
Computes the maximum value of a numeric array.

Installation

$ npm install compute-max

For use in the browser, use browserify.

Usage

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

max( arr )

Computes the maximum value of a numeric array.
var data = [ 3, 2, 5, 4, 4, 5 ];

var val = max( data );
// returns 5

Examples

var data = new Array( 1000 );

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

console.log( max( data ) );

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. Athan Reines.