@stdlib/complex-float64-base-mul-add

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!

muladd

Perform a multiply-add operation involving three double-precision complex floating-point numbers.

Installation

npm install @stdlib/complex-float64-base-mul-add

Usage

var muladd = require( '@stdlib/complex-float64-base-mul-add' );

muladd( alpha, x, y )

Performs a multiply-add operation involving three double-precision complex floating-point numbers.

var Complex128 = require( '@stdlib/complex-float64-ctor' );

var z1 = new Complex128( 5.0, 3.0 );
var z2 = new Complex128( -2.0, 1.0 );
var z3 = new Complex128( 7.0, -8.0 );

// Compute `alpha*x + y`:
var v = muladd( z1, z2, z3 );
// returns <Complex128>[ -6.0, -9.0 ]

The function supports the following parameters:

• alpha: first complex number.
• x: second complex number.
• y: third complex number.

muladd.assign( ar, ai, xr, xi, yr, yi, out, strideOut, offsetOut )

Performs a multiply-add operation involving three double-precision complex floating-point numbers and assigns the results to an output strided array.

var Float64Array = require( '@stdlib/array-float64' );

var out = new Float64Array( 2 );
var v = muladd.assign( 5.0, 3.0, -2.0, 1.0, 7.0, -8.0, out, 1, 0 );
// returns <Float64Array>[ -6.0, -9.0 ]

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

The function supports the following parameters:

• ar: real component of the first complex number.
• ai: imaginary component of the first complex number.
• xr: real component of the second complex number.
• xi: imaginary component of the second complex number.
• yr: real component of the third complex number.
• yi: imaginary component of the third complex number.
• out: output array.
• strideOut: stride length for out.
• offsetOut: starting index for out.

muladd.strided( alpha, sa, oa, x, sx, ox, y, sy, oy, out, so, oo )

Performs a multiply-add operation involving three double-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array.

var Float64Array = require( '@stdlib/array-float64' );

var z1 = new Float64Array( [ 5.0, 3.0 ] );
var z2 = new Float64Array( [ -2.0, 1.0 ] );
var z3 = new Float64Array( [ 7.0, -8.0 ] );
var out = new Float64Array( 2 );

var v = muladd.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 );
// returns <Float64Array>[ -6.0, -9.0 ]

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

The function supports the following parameters:

• alpha: first complex number strided array view.
• sa: stride length for alpha.
• oa: starting index for alpha.
• x: second complex number strided array view.
• sx: stride length for x.
• ox: starting index for x.
• y: third complex number strided array view.
• sy: stride length for y.
• oy: starting index for y.
• out: output array.
• so: stride length for out.
• oo: starting index for out.

Examples

var Complex128Array = require( '@stdlib/array-complex128' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var muladd = require( '@stdlib/complex-float64-base-mul-add' );

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

// Perform element-wise computation:
logEachMap( '( (%s) * (%s) ) + (%s) = %s', z1, z2, z3, muladd );

C APIs

Usage

#include "stdlib/complex/float64/base/mul_add.h"

stdlib_base_complex128_muladd( alpha, x, y )

Performs a multiply-add operation involving three double-precision complex floating-point numbers.

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

stdlib_complex128_t z1 = stdlib_complex128( 5.0, 3.0 );
stdlib_complex128_t z2 = stdlib_complex128( -2.0, 1.0 );
stdlib_complex128_t z3 = stdlib_complex128( 7.0, -8.0 );

stdlib_complex128_t out = stdlib_base_complex128_muladd( z1, z2, z3 );

double re = stdlib_complex128_real( out );
// returns -6.0

double im = stdlib_complex128_imag( out );
// returns -9.0

The function accepts the following arguments:

• alpha: [in] stdlib_complex128_t input value.
• x: [in] stdlib_complex128_t input value.
• y: [in] stdlib_complex128_t input value.

stdlib_complex128_t stdlib_base_complex128_muladd( const stdlib_complex128_t alpha, const stdlib_complex128_t x, const stdlib_complex128_t y );

Examples

#include "stdlib/complex/float64/base/mul_add.h"
#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/reim.h"
#include <stdio.h>

int main( void ) {
    const stdlib_complex128_t x[] = {
        stdlib_complex128( 3.14, 1.5 ),
        stdlib_complex128( -3.14, 1.5 ),
        stdlib_complex128( 0.0, -0.0 ),
        stdlib_complex128( 0.0/0.0, 0.0/0.0 )
    };

    stdlib_complex128_t v;
    stdlib_complex128_t y;
    double re;
    double im;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        stdlib_complex128_reim( v, &re, &im );
        printf( "z = %lf + %lfi\n", re, im );

        y = stdlib_base_complex128_muladd( v, v, v );
        stdlib_complex128_reim( y, &re, &im );
        printf( "z*z + z = %lf + %lfi\n", re, im );
    }
}

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.