README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Alpha Max Plus Beta Min

Compute the hypotenuse using the alpha max plus beta min algorithm.

Usage

import ampbm from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min@deno/mod.js';

You can also import the following named exports from the package:

import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min@deno/mod.js';

ampbm( x, y )

Computes the hypotenuse using the alpha max plus beta min algorithm.

var h = ampbm( -5.0, 12.0 );
// returns ~13.5

ampbm.factory( alpha, beta, [nonnegative[, ints]] )

Returns a function for computing the hypotenuse using coefficients alpha and beta.

var hypot = ampbm.factory( 1.0, 0.5 );

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

If the returned function should only expect nonnegative arguments, set the nonnegative argument to true.

var hypot = ampbm.factory( 1.0, 0.5, true );

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

If the returned function should only expect signed 32-bit integers, set the ints argument to true.

var hypot = ampbm.factory( 1.0, 0.5, false, true );

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

If the returned function should only expect unsigned 32-bit integer valued arguments, set the nonnegative and ints arguments to true.

var hypot = ampbm.factory( 1.0, 0.5, true, true );

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

Notes

• The algorithm computes only an approximation. For precise results, use hypot.

Examples

import randu from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@deno/mod.js';
import round from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-round@deno/mod.js';
import ampbm from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min@deno/mod.js';

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 = ampbm( x, y );
    console.log( 'hypot(%d,%d) = %d', x, y, h );
}

References

• Lyons, Richard G. 2011. Understanding Digital Signal Processing, 3rd Edition. Prentice Hall.

---

See Also

• @stdlib/math-base/special/hypot: compute the hypotenuse avoiding overflow and underflow.

---

Notice

This package is part of stdlib, a standard library 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.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.