feat!: update math/base/special/cabsf to accept stdlib complex numbers

This commit updates the C API to operate on stdlib's single-precision complex number dtype.

BREAKING CHANGE: use stdlib C complex64 dtype

To migrate, users should provide a value having the type `stdlib_complex64_t`, rather than a built-in C99 single-precision complex dtype. This dtype is available via the package `@stdlib/complex/float32/ctor`.

PR-URL: #3358
Closes: #3357

Co-authored-by: stdlib-bot <[email protected]>
Reviewed-by: Athan Reines <[email protected]>
Reviewed-by: Karan Anand <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

Author: aayush0325

Diff for: lib/node_modules/@stdlib/math/base/special/cabsf/README.md

@@ -55,7 +55,7 @@ var cabsf = require( '@stdlib/math/base/special/cabsf' );
 
 #### cabsf( z )
 
-Computes an [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.
+Computes the [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.
 
 ```javascript
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
@@ -125,21 +125,23 @@ for ( i = 0; i < 100; i++ ) {
 
 #### stdlib_base_cabsf( z )
 
-Computes an [absolute value][absolute-value] of a single-precision complex floating-point number.
+Computes the [absolute value][absolute-value] of a single-precision complex floating-point number.
 
 ```c
-#include <complex.h>
+#include "stdlib/complex/float32/ctor.h"
 
-float y = stdlib_base_cabsf( 5.0+3.0*I );
+stdlib_complex64_t z = stdlib_complex64( 5.0f, 3.0f );
+
+float y = stdlib_base_cabsf( z );
 // returns ~5.83f
 ```
 
 The function accepts the following arguments:
 
--   **z**: `[in] float complex` input value.
+-   **z**: `[in] stdlib_complex64_t` input value.
 
 ```c
-float stdlib_base_cabsf( const float complex z );
+float stdlib_base_cabsf( const stdlib_complex64_t z );
 ```
 
 </section>
@@ -162,19 +164,28 @@ float stdlib_base_cabsf( const float complex z );
 
 ```c
 #include "stdlib/math/base/special/cabsf.h"
+#include "stdlib/complex/float32/ctor.h"
+#include "stdlib/complex/float32/reim.h"
 #include <stdio.h>
-#include <complex.h>
 
 int main( void ) {
-    const float complex x[] = { 3.14f+1.0f*I, -3.14f-1.0f*I, 0.0f+0.0f*I, 0.0f/0.0f+0.0f/0.0f*I };
-
-    float complex v;
+    const stdlib_complex64_t x[] = {
+        stdlib_complex64( 3.14f, 1.0f ),
+        stdlib_complex64( -3.14f, -1.0f ),
+        stdlib_complex64( 0.0f, 0.0f ),
+        stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
+    };
+
+    stdlib_complex64_t v;
+    float re;
+    float im;
     float y;
     int i;
     for ( i = 0; i < 4; i++ ) {
         v = x[ i ];
         y = stdlib_base_cabsf( v );
-        printf( "f(%f + %f) = %f\n", crealf( v ), cimagf( v ), y );
+        stdlib_complex64_reim( v, &re, &im );
+        printf( "f(%f + %f) = %f\n", re, im, y );
     }
 }
 ```

Diff for: lib/node_modules/@stdlib/math/base/special/cabsf/benchmark/benchmark.native.js

@@ -0,0 +1,65 @@
+/**
+* @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 resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var cabsf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+	'skip': ( cabsf instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+	var values;
+	var y;
+	var i;
+
+	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++ ) {
+		y = cabsf( values[ i % values.length ] );
+		if ( isnanf( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

Diff for: lib/node_modules/@stdlib/math/base/special/cabsf/benchmark/c/native/benchmark.c

@@ -17,7 +17,8 @@
 */
 
 #include "stdlib/math/base/special/cabsf.h"
-#include <complex.h>
+#include "stdlib/complex/float32/ctor.h"
+#include "stdlib/complex/float32/reim.h"
 #include <stdlib.h>
 #include <stdio.h>
 #include <math.h>
@@ -91,19 +92,23 @@ static float rand_float( void ) {
 * @return elapsed time in seconds
 */
 static double benchmark( void ) {
-	float complex z;
 	double elapsed;
+	float re[ 100 ];
+	float im[ 100 ];
 	double t;
-	float re;
-	float im;
 	float y;
 	int i;
 
+	for ( i = 0; i < 100; i++ ) {
+		re[ i ] = ( 1000.0f*rand_float() ) - 500.0f;
+		im[ i ] = ( 1000.0f*rand_float() ) - 500.0f;
+	}
+
+	stdlib_complex64_t z;
+
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		re = ( 1000.0f*rand_float() ) - 500.0f;
-		im = ( 1000.0f*rand_float() ) - 500.0f;
-		z = re + im*I;
+		z = stdlib_complex64( re[ i%100 ], im[ i%100 ] );
 		y = stdlib_base_cabsf( z );
 		if ( y != y ) {
 			printf( "should not return NaN\n" );

Diff for: lib/node_modules/@stdlib/math/base/special/cabsf/binding.gyp

@@ -0,0 +1,170 @@
+# @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.
+
+# A `.gyp` file for building a Node.js native add-on.
+#
+# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
+# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
+{
+  # List of files to include in this file:
+  'includes': [
+    './include.gypi',
+  ],
+
+  # Define variables to be used throughout the configuration for all targets:
+  'variables': {
+    # Target name should match the add-on export name:
+    'addon_target_name%': 'addon',
+
+    # Set variables based on the host OS:
+    'conditions': [
+      [
+        'OS=="win"',
+        {
+          # Define the object file suffix:
+          'obj': 'obj',
+        },
+        {
+          # Define the object file suffix:
+          'obj': 'o',
+        }
+      ], # end condition (OS=="win")
+    ], # end conditions
+  }, # end variables
+
+  # Define compile targets:
+  'targets': [
+
+    # Target to generate an add-on:
+    {
+      # The target name should match the add-on export name:
+      'target_name': '<(addon_target_name)',
+
+      # Define dependencies:
+      'dependencies': [],
+
+      # Define directories which contain relevant include headers:
+      'include_dirs': [
+        # Local include directory:
+        '<@(include_dirs)',
+      ],
+
+      # List of source files:
+      'sources': [
+        '<@(src_files)',
+      ],
+
+      # Settings which should be applied when a target's object files are used as linker input:
+      'link_settings': {
+        # Define libraries:
+        'libraries': [
+          '<@(libraries)',
+        ],
+
+        # Define library directories:
+        'library_dirs': [
+          '<@(library_dirs)',
+        ],
+      },
+
+      # C/C++ compiler flags:
+      'cflags': [
+        # Enable commonly used warning options:
+        '-Wall',
+
+        # Aggressive optimization:
+        '-O3',
+      ],
+
+      # C specific compiler flags:
+      'cflags_c': [
+        # Specify the C standard to which a program is expected to conform:
+        '-std=c99',
+      ],
+
+      # C++ specific compiler flags:
+      'cflags_cpp': [
+        # Specify the C++ standard to which a program is expected to conform:
+        '-std=c++11',
+      ],
+
+      # Linker flags:
+      'ldflags': [],
+
+      # Apply conditions based on the host OS:
+      'conditions': [
+        [
+          'OS=="mac"',
+          {
+            # Linker flags:
+            'ldflags': [
+              '-undefined dynamic_lookup',
+              '-Wl,-no-pie',
+              '-Wl,-search_paths_first',
+            ],
+          },
+        ], # end condition (OS=="mac")
+        [
+          'OS!="win"',
+          {
+            # C/C++ flags:
+            'cflags': [
+              # Generate platform-independent code:
+              '-fPIC',
+            ],
+          },
+        ], # end condition (OS!="win")
+      ], # end conditions
+    }, # end target <(addon_target_name)
+
+    # Target to copy a generated add-on to a standard location:
+    {
+      'target_name': 'copy_addon',
+
+      # Declare that the output of this target is not linked:
+      'type': 'none',
+
+      # Define dependencies:
+      'dependencies': [
+        # Require that the add-on be generated before building this target:
+        '<(addon_target_name)',
+      ],
+
+      # Define a list of actions:
+      'actions': [
+        {
+          'action_name': 'copy_addon',
+          'message': 'Copying addon...',
+
+          # Explicitly list the inputs in the command-line invocation below:
+          'inputs': [],
+
+          # Declare the expected outputs:
+          'outputs': [
+            '<(addon_output_dir)/<(addon_target_name).node',
+          ],
+
+          # Define the command-line invocation:
+          'action': [
+            'cp',
+            '<(PRODUCT_DIR)/<(addon_target_name).node',
+            '<(addon_output_dir)/<(addon_target_name).node',
+          ],
+        },
+      ], # end actions
+    }, # end target copy_addon
+  ], # end targets
+}

Diff for: lib/node_modules/@stdlib/math/base/special/cabsf/examples/c/example.c

@@ -17,18 +17,27 @@
 */
 
 #include "stdlib/math/base/special/cabsf.h"
+#include "stdlib/complex/float32/ctor.h"
+#include "stdlib/complex/float32/reim.h"
 #include <stdio.h>
-#include <complex.h>
 
 int main( void ) {
-	float complex x[] = { 3.14f+1.0f*I, -3.14f-1.0f*I, 0.0f+0.0f*I, 0.0f/0.0f+0.0f/0.0f*I };
+	const stdlib_complex64_t x[] = {
+		stdlib_complex64( 3.14f, 1.0f ),
+		stdlib_complex64( -3.14f, -1.0f ),
+		stdlib_complex64( 0.0f, 0.0f ),
+		stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
+	};
 
-	float complex v;
+	stdlib_complex64_t v;
+	float re;
+	float im;
 	float y;
 	int i;
 	for ( i = 0; i < 4; i++ ) {
 		v = x[ i ];
 		y = stdlib_base_cabsf( v );
-		printf( "f(%f + %f) = %f\n", crealf( v ), cimagf( v ), y );
+		stdlib_complex64_reim( v, &re, &im );
+		printf( "f(%f + %f) = %f\n", re, im, y );
 	}
 }