fix: add review changes

stdlib-js · Jul 11, 2023 · 1f8538d · 1f8538d
1 parent fcbed0b
commit 1f8538d
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 20 deletions.
diff --git a/lib/node_modules/@stdlib/math/base/special/cround/README.md b/lib/node_modules/@stdlib/math/base/special/cround/README.md
@@ -18,9 +18,9 @@ limitations under the License.
 
 -->
 
-# Round
+# cround
 
-> Round a double-precision complex floating-point number to the nearest integer.
+> Round each component of a double-precision complex floating-point number to the nearest integer.
 
 <section class="usage">
 
@@ -32,7 +32,7 @@ var cround = require( '@stdlib/math/base/special/cround' );
 
 #### cround( z )
 
-Rounds a double-precision complex floating-point number to the nearest integer.
+Rounds each component of a double-precision complex floating-point number to the nearest integer.
 
 ```javascript
 var Complex128 = require( '@stdlib/complex/float64' );
@@ -133,7 +133,7 @@ for ( i = 0; i < 100; i++ ) {
 
 #### stdlib_base_cround( z )
 
-Rounds a double-precision complex floating-point number toward positive infinity.
+Rounds each component of a double-precision complex floating-point number to the nearest integer.
 
 ```c
 #include "stdlib/complex/float64.h"
@@ -203,7 +203,7 @@ int main( void ) {
         y = stdlib_base_cround( v );
         stdlib_reim( v, &re1, &im1 );
         stdlib_reim( y, &re2, &im2 );
-        printf( "cceil(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 );
+        printf( "cround(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 );
     }
 }
 ```

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/cround/benchmark/c/native/benchmark.c
@@ -96,21 +96,21 @@ double rand_double() {
 */
 double benchmark() {
 	double elapsed;
-    double re;
-    double im;
+	double re;
+	double im;
 	double t;
 	double v;
 	int i;
 
-    stdlib_complex128_t x;
-    stdlib_complex128_t y;
+	stdlib_complex128_t x;
+	stdlib_complex128_t y;
 
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
 		v = ( 1000.0*rand_double() ) - 500.0;
 		x = stdlib_complex128( v, v );
 		y = stdlib_base_cround( x );
-        stdlib_reim( y, &re, &im );
+		stdlib_reim( y, &re, &im );
 		if ( re != re ) {
 			printf( "unexpected result\n" );
 			break;

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt
@@ -1,7 +1,7 @@
 
 {{alias}}( z )
-    Rounds a double-precision complex floating-point number to the nearest
-    integer.
+    Rounds each component of a double-precision complex floating-point number
+    to the nearest integer.
 
     Parameters
     ----------

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts
@@ -23,7 +23,7 @@
 import { Complex128 } from '@stdlib/types/object';
 
 /**
-* Rounds a double-precision complex floating-point number to the nearest integer.
+* Rounds each component of a double-precision complex floating-point number to the nearest integer.
 *
 * @param z - input value
 * @returns result

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/test.ts
@@ -22,7 +22,7 @@ import cround = require( './index' );
 
 // TESTS //
 
-// The function returns an array of numbers...
+// The function returns a double-precision complex floating-point number
 {
 	cround( new Complex128( 1.0, 2.0 ) ); // $ExpectType Complex128
 }

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js
@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Round a double-precision floating-point complex number to the nearest integer.
+* Round each component of a double-precision complex floating-point number to the nearest integer.
 *
 * @module @stdlib/math/base/special/cround
 *

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js
@@ -29,7 +29,7 @@ var imag = require( '@stdlib/complex/imag' );
 // MAIN //
 
 /**
-* Rounds a double-precision floating-point complex number to the nearest integer.
+* Rounds each component of a double-precision complex floating-point number to the nearest integer.
 *
 * @param {Complex128} z - complex number
 * @returns {Complex128} rounded complex number

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/package.json b/lib/node_modules/@stdlib/math/base/special/cround/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/math/base/special/cround",
   "version": "0.0.0",
-  "description": "Round a double-precision complex floating-point number to the nearest integer.",
+  "description": "Rounds each component of a double-precision complex floating-point number to the nearest integer.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

diff --git a/lib/node_modules/@stdlib/math/base/special/cround/src/main.c b/lib/node_modules/@stdlib/math/base/special/cround/src/main.c
@@ -22,7 +22,7 @@
 #include <math.h>
 
 /**
-* Rounds a double-precision complex floating-point number to the nearest integer.
+* Rounds each component of a double-precision complex floating-point number to the nearest integer.
 *
 * @param z       input value
 * @return        result
@@ -48,7 +48,7 @@ stdlib_complex128_t stdlib_base_cround( const stdlib_complex128_t z ) {
 
 	stdlib_reim( z, &re, &im );
 
-	re = round( re );
-	im = round( im );
+	re = round( re ); // TODO: replace with stdlib function once available
+	im = round( im ); // TODO: replace with stdlib function once available
 	return stdlib_complex128( re, im );
 }