feat: add math/base/special/cpolarf

Author: anandkaranubc

lib/node_modules/@stdlib/math/base/special/cpolarf/README.md

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2018 The Stdlib Authors.
+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.
@@ -77,9 +77,7 @@ var bool = ( v === out );
 ```javascript
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
 var randu = require( '@stdlib/random/base/randu' );
-var round = require( '@stdlib/math/base/special/round' );
-var real = require( '@stdlib/complex/float32/real' );
-var imag = require( '@stdlib/complex/float32/imag' );
+var roundf = require( '@stdlib/math/base/special/roundf' );
 var cpolarf = require( '@stdlib/math/base/special/cpolarf' );
 
 var re;
@@ -89,12 +87,12 @@ var o;
 var i;
 
 for ( i = 0; i < 100; i++ ) {
-    re = round( randu()*100.0 ) - 50.0;
-    im = round( randu()*100.0 ) - 50.0;
+    re = roundf( randu()*100.0 ) - 50.0;
+    im = roundf( randu()*100.0 ) - 50.0;
     z = new Complex64( re, im );
     o = cpolarf( z );
     z = z.toString();
-    console.log( 'abs(%s) = %d. arg(%s) = %d', z, o[0], z, o[1] );
+    console.log( 'absf(%s) = %d. argf(%s) = %d', z, o[0], z, o[1] );
 }
 ```
 
@@ -137,20 +135,20 @@ Computes the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdl
 #include "stdlib/complex/float32/real.h"
 #include "stdlib/complex/float32/imag.h"
 
-stdlib_complex128_t z = stdlib_complex128( 5.0, 3.0 );
-double cabsf;
-double cphasef;
+stdlib_complex64_t z = stdlib_complex64( 5.0f, 3.0f );
+float cabsf;
+float cphasef;
 stdlib_base_cpolarf( z, &cabsf, &cphasef );
 ```
 
 The function accepts the following arguments:
 
--   **z**: `[in] stdlib_complex128_t` input value.
--   **cabsf**: `[out] double*` destination for the absolute value.
--   **cphasef**: `[out] double*` destination for the phase value in radians.
+-   **z**: `[in] stdlib_complex64_t` input value.
+-   **cabsf**: `[out] float*` destination for the absolute value.
+-   **cphasef**: `[out] float*` destination for the phase value in radians.
 
 ```c
-double stdlib_base_cpolarf( const stdlib_complex128_t z, double *cabsf, double *cphasef );
+float stdlib_base_cpolarf( const stdlib_complex64_t z, float *cabsf, float *cphasef );
 ```
 
 </section>
@@ -178,22 +176,22 @@ double stdlib_base_cpolarf( const stdlib_complex128_t z, double *cabsf, double *
 #include <stdio.h>
 
 int main( void ) {
-    const stdlib_complex128_t x[] = {
-        stdlib_complex128( 3.14, 1.0 ),
-        stdlib_complex128( -3.14, -1.0 ),
-        stdlib_complex128( 0.0, 0.0 ),
-        stdlib_complex128( 0.0/0.0, 0.0/0.0 )
+    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 )
     };
 
-    double cphasef;
-    double cabsf;
-    double re;
-    double im;
+    float cphasef;
+    float cabsf;
+    float re;
+    float im;
     int i;
     for ( i = 0; i < 4; i++ ) {
         stdlib_base_cpolarf( x[i], &cabsf, &cphasef );
-        stdlib_complex128_reim( x[i], &re, &im );
-        printf( "cpolarf(%lf + %lfi) => cabsf: %lf, cphasef: %lf\n", re, im, cabsf, cphasef );
+        stdlib_complex64_reim( x[i], &re, &im );
+        printf( "cpolarf(%f + %fi) => cabsf: %f, cphasef: %f\n", re, im, cabsf, cphasef );
     }
 }
 ```
@@ -210,13 +208,6 @@ int main( void ) {
 
 <section class="related">
 
-* * *
-
-## See Also
-
--   <span class="package-name">[`@stdlib/math/base/special/cabsf`][@stdlib/math/base/special/cabsf]</span><span class="delimiter">: </span><span class="description">compute the absolute value of a single-precision complex floating-point number.</span>
--   <span class="package-name">[`@stdlib/math/base/special/cphasef`][@stdlib/math/base/special/cphasef]</span><span class="delimiter">: </span><span class="description">compute the argument of a single-precision complex floating-point number in radians.</span>
-
 </section>
 
 <!-- /.related -->

lib/node_modules/@stdlib/math/base/special/cpolarf/benchmark/benchmark.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* 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.

lib/node_modules/@stdlib/math/base/special/cpolarf/benchmark/benchmark.native.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* 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.
@@ -23,7 +23,7 @@
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
 var uniform = require( '@stdlib/random/base/uniform' );
-var isArray = require( '@stdlib/assert/is-array' );
+var isFloat32Array = require( '@stdlib/assert/is-float32array' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
@@ -57,8 +57,8 @@ bench( pkg+'::native', opts, function benchmark( b ) {
 		}
 	}
 	b.toc();
-	if ( !isArray( y ) ) {
-		b.fail( 'should return an array' );
+	if ( !isFloat32Array( y ) ) {
+		b.fail( 'should return a Float32Array' );
 	}
 	b.pass( 'benchmark finished' );
 	b.end();

lib/node_modules/@stdlib/math/base/special/cpolarf/benchmark/c/native/Makefile

@@ -1,7 +1,7 @@
 #/
 # @license Apache-2.0
 #
-# Copyright (c) 2023 The Stdlib Authors.
+# 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.

lib/node_modules/@stdlib/math/base/special/cpolarf/benchmark/c/native/benchmark.c

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* 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.
@@ -81,9 +81,9 @@ static double tic( void ) {
 *
 * @return random number
 */
-static double rand_double( void ) {
+static float rand_float( void ) {
 	int r = rand();
-	return (double)r / ( (double)RAND_MAX + 1.0 );
+	return (float)r / ( (float)RAND_MAX + 1.0f );
 }
 
 /**
@@ -93,21 +93,23 @@ static double rand_double( void ) {
 */
 static double benchmark( void ) {
 	double elapsed;
-	double cphasef;
-	double cabsf;
-	double re;
-	double im;
+	float cphasef;
+	float cabsf;
+	float re;
+	float im;
 	double t;
 	int i;
 
-	stdlib_complex128_t z;
+	stdlib_complex64_t z[ 100 ];
+	for ( i = 0; i < 100; i++ ) {
+		re = ( 1000.0f*rand_float() ) - 500.0f;
+		im = ( 1000.0f*rand_float() ) - 500.0f;
+		z[ i ] = stdlib_complex64( re, im );
+	}
 
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		re = ( 1000.0*rand_double() ) - 500.0;
-		im = ( 1000.0*rand_double() ) - 500.0;
-		z = stdlib_complex128( re, im );
-		stdlib_base_cpolarf( z, &cabsf, &cphasef);
+		stdlib_base_cpolarf( z[ i%100 ], &cabsf, &cphasef);
 		if ( cabsf != cabsf ) {
 			printf( "should not return NaN\n" );
 			break;

lib/node_modules/@stdlib/math/base/special/cpolarf/binding.gyp

@@ -1,6 +1,6 @@
 # @license Apache-2.0
 #
-# Copyright (c) 2023 The Stdlib Authors.
+# 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.

lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/index.d.ts

@@ -1,7 +1,7 @@
 /*
 * @license Apache-2.0
 *
-* Copyright (c) 2019 The Stdlib Authors.
+* 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.

lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/test.ts

@@ -1,7 +1,7 @@
 /*
 * @license Apache-2.0
 *
-* Copyright (c) 2019 The Stdlib Authors.
+* 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.

lib/node_modules/@stdlib/math/base/special/cpolarf/examples/c/Makefile

@@ -1,7 +1,7 @@
 #/
 # @license Apache-2.0
 #
-# Copyright (c) 2023 The Stdlib Authors.
+# 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.

lib/node_modules/@stdlib/math/base/special/cpolarf/examples/c/example.c

@@ -2,7 +2,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2023 The Stdlib Authors.
+* 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.
@@ -23,21 +23,21 @@
 #include <stdio.h>
 
 int main( void ) {
-	const stdlib_complex128_t x[] = {
-		stdlib_complex128( 3.14, 1.0 ),
-		stdlib_complex128( -3.14, -1.0 ),
-		stdlib_complex128( 0.0, 0.0 ),
-		stdlib_complex128( 0.0/0.0, 0.0/0.0 )
+	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 )
 	};
 
-	double cphasef;
-	double cabsf;
-	double re;
-	double im;
+	float cphasef;
+	float cabsf;
+	float re;
+	float im;
 	int i;
 	for ( i = 0; i < 4; i++ ) {
 		stdlib_base_cpolarf( x[i], &cabsf, &cphasef );
-		stdlib_complex128_reim( x[i], &re, &im );
-		printf( "cpolarf(%lf + %lfi) => cabsf: %lf, cphasef: %lf\n", re, im, cabsf, cphasef );
+		stdlib_complex64_reim( x[i], &re, &im );
+		printf( "cpolarf(%f + %fi) => cabsf: %f, cphasef: %f\n", re, im, cabsf, cphasef );
 	}
 }