time-to-botec/squiggle/node_modules/@stdlib/complex/cmplx/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

3.0 KiB

Complex Numbers

Create a complex number.

Usage

var complex = require( '@stdlib/complex/cmplx' );

complex( real, imag[, dtype] )

Creates a complex number, where real and imag are the real and imaginary components, respectively.

var z = complex( 5.0, 3.0 );
// returns <Complex128>

By default, the function returns a 128-bit complex number. To specify an alternative underlying data type, set the dtype parameter to one of the following:

var z = complex( 5.0, 3.0, 'float32' );
// returns <Complex64>

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var complex = require( '@stdlib/complex/cmplx' );

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 = complex( re, im, 'float64' );
    console.log( z.toString() );
}