feat: add complex/float32/base/mul-add

lib/node_modules/@stdlib/complex/float32/base/mul-add/README.md

@@ -0,0 +1,294 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# muladd
+
+> Perform a multiply-add operation involving three single-precision complex floating-point numbers.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var muladd = require( '@stdlib/complex/float32/base/mul-add' );
+```
+
+#### muladd( alpha, x, y )
+
+Performs a multiply-add operation involving three single-precision complex floating-point numbers.
+
+```javascript
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+var realf = require( '@stdlib/complex/float32/real' );
+var imagf = require( '@stdlib/complex/float32/imag' );
+
+var z1 = new Complex64( 5.0, 3.0 );
+var z2 = new Complex64( -2.0, 1.0 );
+var z3 = new Complex64( 7.0, -8.0 );
+
+// Compute `alpha*x + y`:
+var v = muladd( z1, z2, z3 );
+// returns <Complex64>
+
+var re = realf( v );
+// returns -6.0
+
+var im = imagf( v );
+// returns -9.0
+```
+
+The function supports the following parameters:
+
+-   **alpha**: first [complex number][@stdlib/complex/float32/ctor]
+-   **x**: second [complex number][@stdlib/complex/float32/ctor].
+-   **y**: third [complex number][@stdlib/complex/float32/ctor].
+
+#### muladd.assign( ar, ai, xr, xi, yr, yi, out, strideOut, offsetOut )
+
+Performs a multiply-add operation involving three single-precision complex floating-point numbers and assigns the results to an output strided array.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var out = new Float32Array( 2 );
+var v = muladd.assign( 5.0, 3.0, -2.0, 1.0, 7.0, -8.0, out, 1, 0 );
+// returns <Float32Array>[ -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 single-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var z1 = new Float32Array( [ 5.0, 3.0 ] );
+var z2 = new Float32Array( [ -2.0, 1.0 ] );
+var z3 = new Float32Array( [ 7.0, -8.0 ] );
+var out = new Float32Array( 2 );
+
+var v = muladd.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 );
+// returns <Float32Array>[ -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`.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var muladd = require( '@stdlib/complex/float32/base/mul-add' );
+
+// Generate arrays of random values:
+var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
+var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
+var z3 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
+
+// Perform element-wise computation:
+logEachMap( '( (%s) * (%s) ) + (%s) = %s', z1, z2, z3, muladd );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/complex/float32/base/mul_add.h"
+```
+
+#### stdlib_base_complex64_muladd( alpha, x, y )
+
+Performs a multiply-add operation involving three single-precision complex floating-point numbers.
+
+```c
+#include "stdlib/complex/float32/ctor.h"
+#include "stdlib/complex/float32/real.h"
+#include "stdlib/complex/float32/imag.h"
+
+stdlib_complex64_t z1 = sstdlib_complex64( 5.0, 3.0 );
+stdlib_complex64_t z2 = sstdlib_complex64( -2.0, 1.0 );
+stdlib_complex64_t z3 = sstdlib_complex64( 7.0, -8.0 );
+
+stdlib_complex64_t out = stdlib_base_complex64_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_complex64_t` input value.
+-   **z1**: `[in] stdlib_complex64_t` input value.
+-   **z2**: `[in] stdlib_complex64_t` input value.
+
+```c
+stdlib_complex64_t stdlib_base_complex64_muladd( const stdlib_complex64_t alpha, const stdlib_complex64_t x, const stdlib_complex64_t y );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/complex/float32/base/mul_add.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.14, 1.5 ),
+        stdlib_complex64( -3.14, 1.5 ),
+        stdlib_complex64( 0.0, -0.0 ),
+        stdlib_complex64( 0.0/0.0, 0.0/0.0 )
+    };
+
+    stdlib_complex64_t v;
+    stdlib_complex64_t y;
+    double re;
+    double 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_muladd( v, v, v );
+        stdlib_complex64_reim( y, &re, &im );
+        printf( "z*z + z = %f + %fi\n", re, im );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/complex/float32/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/ctor
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/complex/float32/base/mul-add/benchmark/benchmark.assign.js

@@ -0,0 +1,70 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var Float32Array = require( '@stdlib/array/float32' );
+var pkg = require( './../package.json' ).name;
+var muladd = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
+// MAIN //
+
+bench( pkg+':assign', function benchmark( b ) {
+	var out;
+	var re;
+	var im;
+	var N;
+	var i;
+	var j;
+	var k;
+
+	N = 100;
+	re = uniform( N, -500.0, 500.0, options );
+	im = uniform( N, -500.0, 500.0, options );
+
+	out = new Float32Array( 2 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		j = i % N;
+		k = ( i+1 ) % N;
+		out = muladd.assign( re[ j ], im[ j ], re[ k ], im[ k ], re[ k ], im[ k ], out, 1, 0 ); // eslint-disable-line max-len
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( isnanf( out[ 0 ] ) || isnanf( out[ 1 ] ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});