Greatest Common Divisor
Computes the greatest common divisor (gcd).
Note: the gcd is also known as the greatest common factor (gcf), highest common factor (hcf), highest common divisor, and greatest common measure (gcm).
Installation
$ npm install compute-gcd
For use in the browser, use browserify.
Usage
var gcd = ;
gcd( a, b[, c,...,n] )
Computes the greatest common divisor (gcd) of two or more integers
.
var val = ;// returns 6var val = ;// returns 4
gcd( arr[, accessor] )
Computes the greatest common divisor (gcd) of two or more integers
.
var val = ;// returns 6var val = ;// returns 4
For object arrays
, provide an accessor function
for accessing array
values
var data ='beep' 4'boop' 8'bap' 12'baz' 16;{return d 1 ;}var arr = ;// returns 4
Notes
- For more than 3 values, a performance gain can be achieved if the values are sorted in ascending order.
- If provided an
array
with a length less than2
or a singleinteger
argument, the function returnsnull
.
Examples
var gcd = ;// Compute the gcd of random tuples...var x y z arr val;for var i = 0; i < 100; i++x = Math;y = Math;z = Math;arr = x y z ;val = ;console;
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
Copyright
Copyright © 2014-2015. Athan Reines.