@stdlib/math-base-ops-cmul

multiply

Multiply two complex numbers.

Installation

npm install @stdlib/math-base-ops-cmul

Usage

var cmul = require( '@stdlib/math-base-ops-cmul' );

cmul( [out,] re1, im1, re2, im2 )

Multiplies two complex numbers where each complex number is comprised of a real component re and an imaginary component im.

var v = cmul( 5.0, 3.0, -2.0, 1.0 );
// returns [ -13.0, -1.0 ]

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 v = cmul( out, 5.0, 3.0, -2.0, 1.0 );
// returns <Float64Array>[ -13.0, -1.0 ]

var bool = ( v === 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 cmul = require( '@stdlib/math-base-ops-cmul' );

var re;
var im;
var z1;
var z2;
var z3;
var o;
var i;

for ( i = 0; i < 100; i++ ) {
    re = round( randu()*100.0 ) - 50.0;
    im = round( randu()*100.0 ) - 50.0;
    z1 = new Complex128( re, im );

    re = round( randu()*100.0 ) - 50.0;
    im = round( randu()*100.0 ) - 50.0;
    z2 = new Complex128( re, im );

    o = cmul( real(z1), imag(z1), real(z2), imag(z2) );
    z3 = new Complex128( o[ 0 ], o[ 1 ] );

    console.log( '(%s) * (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}

---

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.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.