Package Exports

@stdlib/math-base-special-fast-hypot

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-fast-hypot) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

hypot

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Compute the hypotenuse.

Installation

npm install @stdlib/math-base-special-fast-hypot

Usage

var hypot = require( '@stdlib/math-base-special-fast-hypot' );

hypot( x, y )

Computes the hypotenuse.

var h = hypot( -5.0, 12.0 );
// returns 13.0

Notes

For a sufficiently large x and/or y, computing the hypotenuse will overflow.
```
var h = hypot( 1.0e154, 1.0e154 );
// returns Infinity
```
Similarly, for sufficiently small x and/or y, computing the hypotenuse will underflow.
```
var h = hypot( 1e-200, 1.0e-200 );
// returns 0.0
```

Examples

var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var hypot = require( '@stdlib/math-base-special-fast-hypot' );

var x;
var y;
var h;
var i;

for ( i = 0; i < 100; i++ ) {
    x = round( randu()*100.0 ) - 50.0;
    y = round( randu()*100.0 ) - 50.0;
    h = hypot( x, y );
    console.log( 'hypot(%d,%d) = %d', x, y, h );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

License

See LICENSE.

@stdlib/math-base-special-fast-hypot