README
polar
Compute the absolute value and phase of a complex number.
Installation
npm install @stdlib/math-base-special-cpolar
Usage
var cpolar = require( '@stdlib/math-base-special-cpolar' );
cpolar( [out,] re, im )
Computes the absolute value and phase of a complex number comprised of a real component re and an imaginary component im.
var o = cpolar( 5.0, 3.0 );
// returns [ ~5.83, ~0.5404 ]
By default, the function returns real and imaginary components as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
var Float64Array = require( '@stdlib/array-float64' );
var out = new Float64Array( 2 );
var o = cpolar( out, 5.0, 3.0 );
// returns <Float64Array>[ ~5.83, ~0.5404 ]
var bool = ( o === out );
// returns true
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 cpolar = require( '@stdlib/math-base-special-cpolar' );
var re;
var im;
var z;
var o;
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 );
o = cpolar( real(z), imag(z) );
z = z.toString();
console.log( 'abs(%s) = %d. arg(%s) = %d', z, o[0], z, o[1] );
}
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
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.