chore: stuff from code review

aayush0325 · aayush0325 · commit 068956cfd553 · 2024-11-13T22:39:44.000+05:30
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/README.md b/lib/node_modules/@stdlib/math/base/special/cinvf/README.md
@@ -29,7 +29,7 @@ The inverse (or reciprocal) of a non-zero complex number `z = a + bi` is defined
 <!-- <equation class="equation" label="eq:complex_inverse" align="center" raw="{\frac {1}{z}}=\frac{\bar{z}}{z{\bar{z}}} = \frac{a}{a^{2}+b^{2}} - \frac{b}{a^2+b^2}i." alt="Complex Inverse" > -->
 
 <div class="equation" align="center" data-raw-text="{\frac {1}{z}}=\frac{\bar{z}}{z{\bar{z}}} = \frac{a}{a^{2}+b^{2}} - \frac{b}{a^2+b^2}i." data-equation="eq:complex_inverse">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@026bc0ee34051ddb44f3222f620bc7a300b9799e/lib/node_modules/@stdlib/math/base/special/cinv/docs/img/equation_complex_inverse.svg" alt="Complex Inverse">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@026bc0ee34051ddb44f3222f620bc7a300b9799e/lib/node_modules/@stdlib/math/base/special/cinvf/docs/img/equation_complex_inverse.svg" alt="Complex Inverse">
     <br>
 </div>
 
@@ -180,7 +180,7 @@ int main() {
         stdlib_complex64( 3.14f, 1.5f ),
         stdlib_complex64( -3.14f, -1.5f ),
         stdlib_complex64( 0.0f, 0.0f ),
-        stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
+        stdlib_complex64( 0.0f / 0.0f, 0.0f / 0.0f )
     };
 
     stdlib_complex64_t v;
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/benchmark/c/Makefile b/lib/node_modules/@stdlib/math/base/special/cinvf/benchmark/c/Makefile
@@ -1,7 +1,7 @@
 #/
 # @license Apache-2.0
 #
-# Copyright (c) 2018 The Stdlib Authors.
+# Copyright (c) 2024 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.
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/cinvf/benchmark/c/native/Makefile
@@ -1,7 +1,7 @@
 #/
 # @license Apache-2.0
 #
-# Copyright (c) 2021 The Stdlib Authors.
+# Copyright (c) 2024 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.
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/index.d.ts
@@ -1,7 +1,7 @@
 /*
 * @license Apache-2.0
 *
-* Copyright (c) 2019 The Stdlib Authors.
+* Copyright (c) 2024 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.
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/test.ts
@@ -1,7 +1,7 @@
 /*
 * @license Apache-2.0
 *
-* Copyright (c) 2019 The Stdlib Authors.
+* Copyright (c) 2024 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.
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/cinvf/examples/c/Makefile
@@ -1,7 +1,7 @@
 #/
 # @license Apache-2.0
 #
-# Copyright (c) 2023 The Stdlib Authors.
+# Copyright (c) 2024 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.
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/cinvf/examples/c/example.c
@@ -26,7 +26,7 @@ int main() {
 		stdlib_complex64( 3.14f, 1.5f ),
 		stdlib_complex64( -3.14f, -1.5f ),
 		stdlib_complex64( 0.0f, 0.0f ),
-		stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )
+		stdlib_complex64( 0.0f / 0.0f, 0.0f / 0.0f )
 	};
 
 	stdlib_complex64_t v;
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/main.js
@@ -22,8 +22,8 @@
 
 var absf = require( '@stdlib/math/base/special/absf' );
 var maxf = require( '@stdlib/math/base/special/maxf' );
-var FLOAT64_BIGGEST = require( '@stdlib/constants/float32/max' );
-var FLOAT64_SMALLEST = require( '@stdlib/constants/float32/smallest-normal' );
+var FLOAT32_BIGGEST = require( '@stdlib/constants/float32/max' );
+var FLOAT32_SMALLEST = require( '@stdlib/constants/float32/smallest-normal' );
 var EPS = require( '@stdlib/constants/float32/eps' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
 var real = require( '@stdlib/complex/float32/real' );
@@ -32,8 +32,8 @@ var imag = require( '@stdlib/complex/float32/imag' );
 
 // VARIABLES //
 
-var LARGE_THRESHOLD = FLOAT64_BIGGEST * 0.5;
-var SMALL_THRESHOLD = FLOAT64_SMALLEST * ( 2.0 / EPS );
+var LARGE_THRESHOLD = FLOAT32_BIGGEST * 0.5;
+var SMALL_THRESHOLD = FLOAT32_SMALLEST * ( 2.0 / EPS );
 var RECIP_EPS_SQR = 2.0 / ( EPS * EPS );
 
 
@@ -73,7 +73,7 @@ function cinvf( z ) {
 
 	re = real( z );
 	im = imag( z );
-	ab = maxf( absf(re), absf(im) );
+	ab = maxf( absf( re ), absf( im ) );
 	s = 1.0;
 	if ( ab >= LARGE_THRESHOLD ) {
 		re *= 0.5;
@@ -86,12 +86,12 @@ function cinvf( z ) {
 	}
 	if ( absf( im ) <= absf( re ) ) {
 		r = im / re;
-		t = 1.0 / ( re + (im*r) );
+		t = 1.0 / ( re + ( im * r) );
 		re = t;
 		im = -r * t;
 	} else {
 		r = re / im;
-		t = 1.0 / ( im + (re*r) );
+		t = 1.0 / ( im + ( re * r) );
 		re = r * t;
 		im = -t;
 	}
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/native.js
@@ -34,7 +34,7 @@ var addon = require( './../src/addon.node' );
 * @returns {Complex64} result
 *
 * @example
-* var Complex128 = require( '@stdlib/complex/float32/ctor' );
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
 * var real = require( '@stdlib/complex/float32/real' );
 * var imag = require( '@stdlib/complex/float32/imag' );
 *
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/package.json b/lib/node_modules/@stdlib/math/base/special/cinvf/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@stdlib/math/base/special/cinv",
+  "name": "@stdlib/math/base/special/cinvf",
   "version": "0.0.0",
   "description": "Compute the inverse of a single-precision complex floating-point number.",
   "license": "Apache-2.0",
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/src/Makefile b/lib/node_modules/@stdlib/math/base/special/cinvf/src/Makefile
@@ -1,7 +1,7 @@
 #/
 # @license Apache-2.0
 #
-# Copyright (c) 2023 The Stdlib Authors.
+# Copyright (c) 2024 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.
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/src/main.c b/lib/node_modules/@stdlib/math/base/special/cinvf/src/main.c
@@ -84,12 +84,12 @@ stdlib_complex64_t stdlib_base_cinvf( const stdlib_complex64_t z ) {
 	}
 	if ( stdlib_base_absf( im ) <= stdlib_base_absf( re ) ) {
 		r = im / re;
-		t = 1.0f / ( re + (im * r) );
+		t = 1.0f / ( re + ( im * r ) );
 		re = t;
 		im = -r * t;
 	} else {
 		r = re / im;
-		t = 1.0f / ( im + (re * r) );
+		t = 1.0f / ( im + ( re * r ) );
 		re = r * t;
 		im = -t;
 	}
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/test/fixtures/julia/runner.jl b/lib/node_modules/@stdlib/math/base/special/cinvf/test/fixtures/julia/runner.jl
@@ -41,7 +41,7 @@ function gen( re, im, name )
 	zre = Array{Float32}( undef, length(re) );
 	zim = Array{Float32}( undef, length(re) );
 	for i in eachindex(re)
-		z = 1.0 / Complex{Float32}( re[i], im[i] );
+		z = 1.0 / Complex{Float32}( re[i  ], im[ i ] );
 		zre[ i ] = real( z );
 		zim[ i ] = imag( z );
 	end
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/test/test.js b/lib/node_modules/@stdlib/math/base/special/cinvf/test/test.js
@@ -54,7 +54,7 @@ tape( 'main export is a function', function test( t ) {
 	t.end();
 });
 
-tape( 'the function computes the inverse of a double-precision complex floating-point number', function test( t ) {
+tape( 'the function computes the inverse of a single-precision complex floating-point number', function test( t ) {
 	var v;
 
 	v = cinvf( new Complex64( 2.0, 4.0 ) );
@@ -431,16 +431,16 @@ tape( 'if a real or imaginary component is `NaN`, all components are `NaN`', fun
 	var v;
 
 	v = cinvf( new Complex64( NaN, 3.0 ) );
-	t.strictEqual( isnanf( real( v ) ), true, 'returns NaN' );
-	t.strictEqual( isnanf( imag( v ) ), true, 'returns NaN' );
+	t.strictEqual( isnanf( real( v ) ), true, 'returns expected value' );
+	t.strictEqual( isnanf( imag( v ) ), true, 'returns expected value' );
 
 	v = cinvf( new Complex64( 5.0, NaN ) );
-	t.strictEqual( isnanf( real( v ) ), true, 'returns NaN' );
-	t.strictEqual( isnanf( imag( v ) ), true, 'returns NaN' );
+	t.strictEqual( isnanf( real( v ) ), true, 'returns expected value' );
+	t.strictEqual( isnanf( imag( v ) ), true, 'returns expected value' );
 
 	v = cinvf( new Complex64( NaN, NaN ) );
-	t.strictEqual( isnanf( real( v ) ), true, 'returns NaN' );
-	t.strictEqual( isnanf( imag( v ) ), true, 'returns NaN' );
+	t.strictEqual( isnanf( real( v ) ), true, 'returns expected value' );
+	t.strictEqual( isnanf( imag( v ) ), true, 'returns expected value' );
 
 	t.end();
 });
diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/cinvf/test/test.native.js
@@ -63,7 +63,7 @@ tape( 'main export is a function', opts, function test( t ) {
 	t.end();
 });
 
-tape( 'the function computes the inverse of a double-precision complex floating-point number', opts, function test( t ) {
+tape( 'the function computes the inverse of a single-precision complex floating-point number', opts, function test( t ) {
 	var v;
 
 	v = cinvf( new Complex64( 2.0, 4.0 ) );

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`#/`
`2`	`2`	`# @license Apache-2.0`
`3`	`3`	`#`
`4`		`-# Copyright (c) 2018 The Stdlib Authors.`
	`4`	`+# Copyright (c) 2024 The Stdlib Authors.`
`5`	`5`	`#`
`6`	`6`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`7`	`7`	`# you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/*`
`2`	`2`	`* @license Apache-2.0`
`3`	`3`	`*`
`4`		`-* Copyright (c) 2019 The Stdlib Authors.`
	`4`	`+* Copyright (c) 2024 The Stdlib Authors.`
`5`	`5`	`*`
`6`	`6`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`7`	`7`	`* you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ var addon = require( './../src/addon.node' );`
`34`	`34`	`* @returns {Complex64} result`
`35`	`35`	`*`
`36`	`36`	`* @example`
`37`		`-* var Complex128 = require( '@stdlib/complex/float32/ctor' );`
	`37`	`+* var Complex64 = require( '@stdlib/complex/float32/ctor' );`
`38`	`38`	`* var real = require( '@stdlib/complex/float32/real' );`
`39`	`39`	`* var imag = require( '@stdlib/complex/float32/imag' );`
`40`	`40`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "@stdlib/math/base/special/cinv",`
	`2`	`+ "name": "@stdlib/math/base/special/cinvf",`
`3`	`3`	`"version": "0.0.0",`
`4`	`4`	`"description": "Compute the inverse of a single-precision complex floating-point number.",`
`5`	`5`	`"license": "Apache-2.0",`