diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/README.md b/lib/node_modules/@stdlib/math/base/special/cphase/README.md index 355ac71cc80..44e84cb483a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cphase/README.md @@ -20,7 +20,7 @@ limitations under the License. # phase -> Compute the [argument][complex-number-argument] of a complex number in radians. +> Compute the [argument][complex-number-argument] of a double-precision complex floating-point number in radians.
@@ -61,21 +61,14 @@ var phi = cphase( new Complex128( 5.0, 3.0 ) ); ```javascript 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 uniform = require( '@stdlib/random/base/uniform' ); 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 ); + z = new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ); console.log( 'arg(%s) = %d', z.toString(), cphase( z ) ); } ``` @@ -176,7 +169,7 @@ int main( void ) { y = stdlib_base_cphase( v ); stdlib_reim( v, &re1, &im1 ); stdlib_reim( y, &re2, &im2 ); - printf( "cphase(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 ); + printf( "fcphase(%lf + %lfi) = %lf\n", re, im, y ); } } ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cphase/docs/repl.txt index 41f36b46c2f..dc62445be21 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cphase/docs/repl.txt @@ -1,6 +1,7 @@ {{alias}}( z ) - Computes the argument of a complex number in radians. + Computes the argument of a double-precision complex floating-point 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 diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/index.d.ts index 4378f852107..8dfe3ee8633 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Complex128 } from '@stdlib/types/object'; /** -* Computes the argument of a complex number in radians. +* Computes the argument of a double-precision complex floating-point number in radians. * * ## Notes * diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/test.ts index f2d66a69886..bdc89491998 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/cphase/docs/types/test.ts @@ -22,7 +22,7 @@ import cphase = require( './index' ); // TESTS // -// The function returns a number... +// The function returns a double-precision complex floating-point number... { cphase( new Complex128( 5.0, 3.0 ) ); // $ExpectType number } diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/examples/index.js b/lib/node_modules/@stdlib/math/base/special/cphase/examples/index.js index 84438522e99..5a80ed8d416 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cphase/examples/index.js @@ -19,18 +19,13 @@ 'use strict'; var Complex128 = require( '@stdlib/complex/float64' ); -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var uniform = require( '@stdlib/random/base/uniform' ); var cphase = require( './../lib' ); -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 ); + z = new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ); console.log( 'arg(%s) = %d', z.toString(), cphase( z ) ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/include/stdlib/math/base/special/cphase.h b/lib/node_modules/@stdlib/math/base/special/cphase/include/stdlib/math/base/special/cphase.h index a623950e7ef..ddabef64aee 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/include/stdlib/math/base/special/cphase.h +++ b/lib/node_modules/@stdlib/math/base/special/cphase/include/stdlib/math/base/special/cphase.h @@ -29,7 +29,7 @@ extern "C" { #endif /** -* Computes the argument of a complex number in radians. +* Computes the argument of a double-precision complex floating-point number in radians. */ double stdlib_base_cphase( const stdlib_complex128_t z ); diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cphase/lib/index.js index 94198043a65..ab01fc3c7c8 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cphase/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute the argument of a complex number in radians. +* Compute the argument of a double-precision complex floating-point number in radians. * * @module @stdlib/math/base/special/cphase * diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cphase/lib/main.js index 0de8d0a500b..d9bba5fa319 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cphase/lib/main.js @@ -28,13 +28,14 @@ var imag = require( '@stdlib/complex/imag' ); // MAIN // /** -* Computes the argument of a complex number in radians. +* Computes the argument of a double-precision complex floating-point number in radians. * * @param {Complex128} z - complex number * @returns {number} argument * * @example * var Complex128 = require( '@stdlib/complex/float64' ); +* * var phi = cphase( new Complex128( 5.0, 3.0 ) ); * // returns ~0.5404 */ diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cphase/lib/native.js index bd588abd471..94337ef134e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cphase/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes the argument of a complex number in radians. +* Computes the argument of a double-precision complex floating-point number in radians. * * @private * @param {Complex128} z - complex number diff --git a/lib/node_modules/@stdlib/math/base/special/cphase/src/main.c b/lib/node_modules/@stdlib/math/base/special/cphase/src/main.c index ba45654f8bf..f841ceda945 100644 --- a/lib/node_modules/@stdlib/math/base/special/cphase/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cphase/src/main.c @@ -22,7 +22,7 @@ #include /** -* Computes the argument of a complex number in radians. +* Computes the argument of a complex double-precision complex floating-point number in radians. * * @param z input value * @return argument @@ -41,5 +41,5 @@ double stdlib_base_cphase( const stdlib_complex128_t z ) { double im; stdlib_reim( z, &re, &im ); - return atan2( im, re ); + return atan2( im, re ); // TODO: replace with stdlib function once available } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/cpolar.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/cpolar.js index 02edf35667d..b6cdabd094e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/cpolar.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/cpolar.js @@ -46,8 +46,11 @@ var Complex128 = require( '@stdlib/complex/float64' ); * // returns true */ function cpolar( out, re, im ) { - out[ 0 ] = cabs( new Complex128( re, im ) ); - out[ 1 ] = cphase( new Complex128( re, im ) ); + var z; + + z = new Complex128( re, im ); + out[ 0 ] = cabs( z ); + out[ 1 ] = cphase( z ); return out; }