time-to-botec/squiggle/node_modules/@stdlib/math/base/special/cabs/README.md

Absolute Value

Compute an absolute value of a complex number.

The absolute value of a complex number is defined as

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

Usage

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

cabs( re, im )

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

var y = cabs( 5.0, 3.0 );
// returns ~5.83

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 cabs = require( '@stdlib/math/base/special/cabs' );

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( 'cabs(%s) = %d', z.toString(), cabs( real(z), imag(z) ) );
}