Package Exports

@stdlib/math-base-special-cabs2

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-cabs2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

abs2

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

Compute the squared absolute value of a complex number.

The absolute value of a complex number is defined as

$Absolute value$

which corresponds to the length of a vector from the origin to a complex value plotted in the complex plane.

Installation

npm install @stdlib/math-base-special-cabs2

Usage

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

cabs2( re, im )

Computes the squared absolute value of a complex number comprised of a real component re and an imaginary component im.

var y = cabs2( 5.0, 3.0 );
// returns 34.0

Notes

Be careful to avoid overflow and underflow.
Depending on the environment, this function may have better performance than computing the absolute value of a complex number and then squaring. Hence, where appropriate, consider using cabs2() over cabs().

Examples

var Complex128 = require( '@stdlib/complex-float64' );
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var real = require( '@stdlib/complex-real' );
var imag = require( '@stdlib/complex-imag' );
var cabs2 = require( '@stdlib/math-base-special-cabs2' );

var re;
var im;
var z;
var i;

for ( i = 0; i < 100; i++ ) {
    re = round( randu()*100.0 ) - 50.0;
    im = round( randu()*100.0 ) - 50.0;
    z = new Complex128( re, im );
    console.log( 'cabs2(%s) = %d', z.toString(), cabs2( real(z), imag(z) ) );
}

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-cabs2