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

phase

Compute the argument of a complex number in radians.

The argument of a complex number, also known as the phase, is the angle of the radius extending from the origin to the complex number plotted in the complex plane and the positive real axis.

Usage

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

cphase( re, im )

Computes the argument of a complex number comprised of a real component re and an imaginary component im.

var phi = cphase( 5.0, 3.0 );
// returns ~0.5404

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

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