compute-hypot

Computes the hypotenuse of a right triangle.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
compute-hypot
1.0.010 years ago10 years agoMinified + gzip package size for compute-hypot in KB

Readme

hypot
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependenciesdependencies-imagedependencies-url
Computes the hypotenuse of a right triangle.

Installation

$ npm install compute-hypot

For use in the browser, use browserify.

Usage

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

Examples

var a = 10,
	b = 12;

console.log( hypot( a, b ) );

To run the example code from the top-level application directory,
$ node ./examples/index.js

Notes

The standard approach to calculating the hypotenuse is subject to overflows.
var a2 = a * a;
var b2 = b * b;
var c = Math.sqrt( a2 + b2 );

For a sufficiently large a or b, calculating the square will overflow resulting in an infinite result.
An alternative approach is numerically stable and avoids this problem. This approach is implemented here.

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,
$ open reports/coverage/lcov-report/index.html

License

MIT license.

Copyright

Copyright © 2014. Athan Reines.