math-hypot v1.0.0

hypot

Computes the square root of a sum of squares.

The square root of a sum of squares is defined as

Installation

$ npm install math-hypot

Usage

var hypot = require( 'math-hypot' );

hypot( a, b )

Computes the square root of a sum of squares.

var h = hypot( -5, 12 );
// returns 13

When a and b are both positive numbers, the result can be interpreted as the hypotenuse of a right triangle.

var h = hypot( 5, 12 );
// returns 13

Examples

var hypot = require( 'math-hypot' );

var a;
var b;
var i;

for ( i = 0; i < 100; i++ ) {
	a = Math.round( Math.random()*100 );
	b = Math.round( Math.random()*100 );
	console.log( '%d, %d, %d', a, b, hypot( a, b ) );
}

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

$ node ./examples/index.js

Tests

Unit

This repository uses tape for unit tests. 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

Browser Support

This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

$ make test-browsers

To view the tests in a local web browser,

$ make view-browser-tests

License

MIT license.

Copyright

Copyright © 2016. The Compute.io Authors.