feat: add complex/float32/base/div

lib/node_modules/@stdlib/complex/float32/base/div/README.md

@@ -0,0 +1,249 @@
+<!--
+
+@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.
+
+-->
+
+# div
+
+> Divide two single-precision complex floating-point numbers.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var div = require( '@stdlib/complex/float32/base/div' );
+```
+
+#### div( z1, z2 )
+
+Divides two single-precision complex floating-point numbers.
+
+```javascript
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+
+var z1 = new Complex64( -13.0, -1.0 );
+var z2 = new Complex64( -2.0, 1.0 );
+
+var v = div( z1, z2 );
+// returns <Complex64>[ 5.0, 3.0 ]
+```
+
+</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 div = require( '@stdlib/complex/float32/base/div' );
+
+// Generate arrays of random values:
+var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
+var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) );
+
+// Perform element-wise division:
+logEachMap( '(%s) / (%s) = %s', z1, z2, div );
+```
+
+</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/div.h"
+```
+
+#### stdlib_base_complex64_div( z1, z2 )
+
+Divides two 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 = stdlib_complex64( -13.0, -1.0 );
+stdlib_complex64_t z2 = stdlib_complex64( -2.0, 1.0 );
+
+stdlib_complex64_t out = stdlib_base_complex64_div( z1, z2 );
+
+float re = stdlib_complex64_real( out );
+// returns 5.0
+
+float im = stdlib_complex64_imag( out );
+// returns 3.0
+```
+
+The function accepts the following arguments:
+
+-   **z1**: `[in] stdlib_complex64_t` input value.
+-   **z2**: `[in] stdlib_complex64_t` input value.
+
+```c
+stdlib_complex64_t stdlib_base_complex64_div( const stdlib_complex64_t z1, const stdlib_complex64_t z2 );
+```
+
+</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/div.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;
+    float re;
+    float im;
+    int i;
+    for ( i = 0; i < 4; i++ ) {
+        v = x[ i ];
+        stdlib_complex64_reim( v, &re, &im );
+        printf( "z = %lf + %lfi\n", re, im );
+
+        y = stdlib_base_complex64_div( v, v );
+        stdlib_complex64_reim( y, &re, &im );
+        printf( "div(z, z) = %lf + %lfi\n", re, im );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+* * *
+
+<section class="references">
+
+## References
+
+-   Smith, Robert L. 1962. "Algorithm 116: Complex Division." _Commun. ACM_ 5 (8). New York, NY, USA: ACM: 435. doi:[10.1145/368637.368661][@smith:1962a].
+-   Stewart, G. W. 1985. "A Note on Complex Division." _ACM Trans. Math. Softw._ 11 (3). New York, NY, USA: ACM: 238–41. doi:[10.1145/214408.214414][@stewart:1985a].
+-   Priest, Douglas M. 2004. "Efficient Scaling for Complex Division." _ACM Trans. Math. Softw._ 30 (4). New York, NY, USA: ACM: 389–401. doi:[10.1145/1039813.1039814][@priest:2004a].
+-   Baudin, Michael, and Robert L. Smith. 2012. "A Robust Complex Division in Scilab." _arXiv_ abs/1210.4539 \[cs.MS] (October): 1–25. [&lt;https://arxiv.org/abs/1210.4539>][@baudin:2012a].
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/complex/float32/base/add`][@stdlib/complex/float32/base/add]</span><span class="delimiter">: </span><span class="description">add two single-precision complex floating-point numbers.</span>
+-   <span class="package-name">[`@stdlib/complex/float32/base/mul`][@stdlib/complex/float32/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two single-precision complex floating-point numbers.</span>
+-   <span class="package-name">[`@stdlib/complex/float32/base/sub`][@stdlib/complex/float32/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two single-precision complex floating-point numbers.</span>
+
+</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">
+
+[@smith:1962a]: https://doi.org/10.1145/368637.368661
+
+[@stewart:1985a]: https://doi.org/10.1145/214408.214414
+
+[@priest:2004a]: https://doi.org/10.1145/1039813.1039814
+
+[@baudin:2012a]: https://arxiv.org/abs/1210.4539
+
+<!-- <related-links> -->
+
+[@stdlib/complex/float32/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/add
+
+[@stdlib/complex/float32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/mul
+
+[@stdlib/complex/float32/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/sub
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/complex/float32/base/div/benchmark/benchmark.js

@@ -0,0 +1,111 @@
+/**
+* @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 Complex64 = require( '@stdlib/complex/float32/ctor' );
+var isComplex64 = require( '@stdlib/assert/is-complex64' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var realf = require( '@stdlib/complex/float32/real' );
+var imagf = require( '@stdlib/complex/float32/imag' );
+var absf = require( '@stdlib/math/base/special/absf' );
+var pkg = require( './../package.json' ).name;
+var div = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var values;
+	var y;
+	var i;
+	var z;
+
+	values = [
+		new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ),
+		new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		z = values[ i % values.length ];
+		y = div( z, z );
+		if ( typeof y !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isComplex64( y ) ) {
+		b.fail( 'should return a Complex64' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::smiths_algorithm', function benchmark( b ) {
+	var values;
+	var y;
+	var i;
+	var z;
+
+	values = [
+		new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ),
+		new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		z = values[ i % values.length ];
+		y = div( z, z );
+		if ( typeof y !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isComplex64( y ) ) {
+		b.fail( 'should return a Complex64' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+
+	function div( z1, z2 ) {
+		var re1;
+		var re2;
+		var im1;
+		var im2;
+		var a;
+		var b;
+
+		re1 = realf( z1 );
+		re2 = realf( z2 );
+		im1 = imagf( z1 );
+		im2 = imagf( z2 );
+
+		if ( absf( re2 ) >= absf( im2 ) ) {
+			a = im2 / re2;
+			b = re2 + ( im2 * a );
+			return new Complex64( ( re1 + (im1 * a) )/b, (im1 - (re1*a) )/b );
+		}
+		a = re2 / im2;
+		b = ( re2 * a ) + im2;
+		return new Complex64( ( (re1*a) + im1 )/b, ( (im1*a) - re1 )/b );
+	}
+});