@stdlib/math-base-special-cphase

Compute the argument of a complex number in radians.

Usage no npm install needed!

<script type="module">
  import stdlibMathBaseSpecialCphase from 'https://cdn.skypack.dev/@stdlib/math-base-special-cphase';
</script>

README

phase

NPM version Build Status Coverage Status

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.

Installation

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

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) ) );
}

See Also

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.

Community

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.