@stdlib/complex-float32-base-mul

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

mul

Multiply two single-precision complex floating-point numbers.

Installation

npm install @stdlib/complex-float32-base-mul

Usage

var mul = require( '@stdlib/complex-float32-base-mul' );

mul( z1, z2 )

Multiplies two single-precision complex floating-point numbers.

var Complex64 = require( '@stdlib/complex-float32-ctor' );

var z1 = new Complex64( 5.0, 3.0 );
var z2 = new Complex64( -2.0, 1.0 );

var v = mul( z1, z2 );
// returns <Complex64>[ -13.0, -1.0 ]

mul.assign( re1, im1, re2, im2, out, strideOut, offsetOut )

Multiplies two single-precision complex floating-point numbers and assigns results to a provided output array.

var Float32Array = require( '@stdlib/array-float32' );

var out = new Float32Array( 2 );
var v = mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
// returns <Float32Array>[ -13.0, -1.0 ]

var bool = ( out === v );
// returns true

The function supports the following parameters:

• re1: real component of the first complex number.
• im1: imaginary component of the first complex number.
• re2: real component of the second complex number.
• im2: imaginary component of the second complex number.
• out: output array.
• strideOut: stride length for out.
• offsetOut: starting index for out.

mul.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )

Multiplies two single-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array.

var Float32Array = require( '@stdlib/array-float32' );

var z1 = new Float32Array( [ 5.0, 3.0 ] );
var z2 = new Float32Array( [ -2.0, 1.0 ] );
var out = new Float32Array( 2 );

var v = mul.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 );
// returns <Float32Array>[ -13.0, -1.0 ]

var bool = ( out === v );
// returns true

The function supports the following parameters:

• z1: first complex number strided array view.
• sz1: stride length for z1.
• oz1: starting index for z1.
• z2: second complex number strided array view.
• sz2: stride length for z2.
• oz2: starting index for z2.
• out: output array.
• so: stride length for out.
• oo: starting index for out.

Examples

var Complex64Array = require( '@stdlib/array-complex64' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var mul = require( '@stdlib/complex-float32-base-mul' );

// Generate arrays of random values:
var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) );

// Perform element-wise multiplication:
logEachMap( '(%s) * (%s) = %s', z1, z2, mul );

---

C APIs

Usage

#include "stdlib/complex/float32/base/mul.h"

stdlib_base_complex64_mul( z1, z2 )

Multiplies two single-precision complex floating-point numbers.

#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/real.h"
#include "stdlib/complex/float32/imag.h"

stdlib_complex64_t z1 = stdlib_complex64( 5.0f, 3.0f );
stdlib_complex64_t z2 = stdlib_complex64( -2.0f, 1.0f );

stdlib_complex64_t out = stdlib_base_complex64_mul( z1, z2 );

float re = stdlib_complex64_real( out );
// returns -13.0f

float im = stdlib_complex64_imag( out );
// returns -1.0f

The function accepts the following arguments:

• z1: [in] stdlib_complex64_t input value.
• z2: [in] stdlib_complex64_t input value.

stdlib_complex64_t stdlib_base_complex64_mul( const stdlib_complex64_t z1, const stdlib_complex64_t z2 );

Examples

#include "stdlib/complex/float32/base/mul.h"
#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/reim.h"
#include <stdio.h>

int main( void ) {
    const stdlib_complex64_t x[] = {
        stdlib_complex64( 3.14f, 1.5f ),
        stdlib_complex64( -3.14f, 1.5f ),
        stdlib_complex64( 0.0f, -0.0f ),
        stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
    };

    stdlib_complex64_t v;
    stdlib_complex64_t y;
    float re;
    float im;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        stdlib_complex64_reim( v, &re, &im );
        printf( "z = %f + %fi\n", re, im );

        y = stdlib_base_complex64_mul( v, v );
        stdlib_complex64_reim( y, &re, &im );
        printf( "mul(z, z) = %f + %fi\n", re, im );
    }
}

---

See Also

• @stdlib/complex-float32/base/add: add two single-precision complex floating-point numbers.
• @stdlib/complex-float64/base/mul: multiply two double-precision complex floating-point numbers.
• @stdlib/complex-float32/base/sub: subtract two single-precision complex floating-point numbers.

---

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-2026. The Stdlib Authors.