compute-argmax

Computes the maximum value of a numeric array and returns the corresponding array indices.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
compute-argmax
1.0.08 years ago8 years agoMinified + gzip package size for compute-argmax in KB

Readme

argmax
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependenciesdependencies-imagedependencies-url
Computes the maximum value of a numeric array and returns the corresponding array indices.

Installation

$ npm install compute-argmax

For use in the browser, use browserify.

Usage

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

argmax( arr )

Computes the maximum value of a numeric array and returns the corresponding array indices.
var data = [ 3, 2, 5, 2, 5 ];

var idx = argmax( data );
// returns [2,4]

Examples

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

// Simulate some data...
var data = new Array( 100 );
for ( var i = 0; i < data.length; i++ ) {
	data[ i ] = Math.round( Math.random()*100 );
}
var idx = argmax( data );
console.log( idx );

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.