0.2.1 • Published 2 months ago
@stdlib/complex-cmplx v0.2.1
Complex Numbers
Create a complex number.
Installation
npm install @stdlib/complex-cmplx
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:
'float64'
: store real and imaginary components as double-precision floating-point numbers.'float32'
: store real and imaginary components as single-precision floating-point numbers.
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() );
}
See Also
@stdlib/complex-float64
: 128-bit complex number.@stdlib/complex-float32
: 64-bit complex number.
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-2024. The Stdlib Authors.