chore: clean up

Neerajpathak07 · Neerajpathak07 · commit 545f52eb4a9d · 2025-02-15T16:11:04.000+05:30
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/README.md b/lib/node_modules/@stdlib/stats/base/dnanmean/README.md
@@ -72,26 +72,28 @@ The function has the following parameters:
 
 The `N` and stride parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] of every other element in `x`,
 
+<!-- eslint-disable max-len -->
+
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 
-var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] );
+var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ] );
 
-var v = dnanmean( 4, x, 2 );
+var v = dnanmean( 5, x, 2 );
 // returns 1.25
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
 
-<!-- eslint-disable stdlib/capitalized-comments -->
+<!-- eslint-disable stdlib/capitalized-comments, max-len -->
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 
-var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
+var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-var v = dnanmean( 4, x1, 2 );
+var v = dnanmean( 5, x1, 2 );
 // returns 1.25
 ```
 
@@ -114,12 +116,14 @@ The function has the following additional parameters:
 
 While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the [arithmetic mean][arithmetic-mean] for every other element in `x` starting from the second element
 
+<!-- eslint-disable max-len -->
+
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 
-var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
+var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
 
-var v = dnanmean.ndarray( 4, x, 2, 1 );
+var v = dnanmean.ndarray( 5, x, 2, 1 );
 // returns 1.25
 ```
 
@@ -171,6 +175,22 @@ console.log( v );
 
 <!-- /.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">
@@ -189,7 +209,7 @@ Computes the arithmetic mean of a double-precision floating-point strided array,
 const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };
 
 double v = stdlib_strided_dnanmean( 6, x, 2 );
-// returns 4.66
+// returns ~4.6667
 ```
 
 The function accepts the following arguments:
@@ -210,7 +230,7 @@ Computes the arithmetic mean of a double-precision floating-point strided array,
 const double x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 };
 
 double v = stdlib_strided_dnanmean_ndarray( 6, x, 2, 0 );
-// returns 4.66
+// returns ~4.6667
 ```
 
 The function accepts the following arguments:
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.js
@@ -33,13 +33,13 @@ var dnanmean = require( './../lib/dnanmean.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
-* @returns {number} random number or `NaN`
+* @returns {number} random number
 */
 function rand() {
-	if ( bernoulli( 0.2 ) ) {
+	if ( bernoulli( 0.8 ) < 1 ) {
 		return NaN;
 	}
 	return uniform( -10.0, 10.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.native.js
@@ -42,13 +42,13 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
-* @returns {number} random number or `NaN`
+* @returns {number} random number
 */
 function rand() {
-	if ( bernoulli( 0.2 ) ) {
+	if ( bernoulli( 0.8 ) < 1 ) {
 		return NaN;
 	}
 	return uniform( -10.0, 10.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.js
@@ -33,13 +33,13 @@ var dnanmean = require( './../lib/ndarray.js' );
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
-* @returns {number} random number or `NaN`
+* @returns {number} random number
 */
 function rand() {
-	if ( bernoulli( 0.2 ) ) {
+	if ( bernoulli( 0.8 ) < 1 ) {
 		return NaN;
 	}
 	return uniform( -10.0, 10.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/benchmark.ndarray.native.js
@@ -42,13 +42,13 @@ var opts = {
 // FUNCTIONS //
 
 /**
-* Returns a random value or `NaN`.
+* Returns a random number.
 *
 * @private
-* @returns {number} random number or `NaN`
+* @returns {number} random number
 */
 function rand() {
-	if ( bernoulli( 0.2 ) ) {
+	if ( bernoulli( 0.8 ) < 1 ) {
 		return NaN;
 	}
 	return uniform( -10.0, 10.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/dnanmean/benchmark/c/benchmark.length.c
@@ -102,7 +102,11 @@ static double benchmark1( int iterations, int len ) {
 	int i;
 
 	for ( i = 0; i < len; i++ ) {
-		x[ i ] = ( rand_double() * 20000.0 ) - 10000.0;
+		if ( rand_double() < 0.2 ) {
+			x[ i ] = 0.0 / 0.0; // NaN
+		} else {
+			x[ i ] = ( rand_double()* 20000.0 ) - 10000.0;
+		}
 	}
 	v = 0.0;
 	t = tic();
@@ -136,7 +140,11 @@ static double benchmark2( int iterations, int len ) {
 	int i;
 
 	for ( i = 0; i < len; i++ ) {
-		x[ i ] = ( rand_double() * 20000.0 ) - 10000.0;
+		if ( rand_double() < 0.2 ) {
+			x[ i ] = 0.0 / 0.0; // NaN
+		} else {
+			x[ i ] = ( rand_double()* 20000.0 ) - 10000.0;
+		}
 	}
 	v = 0.0;
 	t = tic();
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dnanmean/docs/repl.txt
@@ -37,14 +37,14 @@
     ~0.3333
 
     // Using `N` and `stride` parameters:
-    > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] );
-    > {{alias}}( 3, x, 2 )
+    > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );
+    > {{alias}}( 4, x, 2 )
     ~0.3333
 
     // Using view offsets:
-    > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
+    > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
     > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > {{alias}}( 3, x1,2 )
+    > {{alias}}( 4, x1,2 )
     ~-0.3333
 
 
@@ -83,8 +83,8 @@
     ~0.3333
 
     // Using offset parameter:
-    > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
-    > {{alias}}.ndarray( 3, x, 2, 1 )
+    > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
+    > {{alias}}.ndarray( 4, x, 2, 1 )
     ~-0.3333
 
     See Also
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/index.js
@@ -36,9 +36,9 @@
 * var Float64Array = require( '@stdlib/array/float64' );
 * var dnanmean = require( '@stdlib/stats/base/dnanmean' );
 *
-* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
+* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
 *
-* var v = dnanmean.ndarray( 4, x, 2, 1 );
+* var v = dnanmean.ndarray( 5, x, 2, 1 );
 * // returns 1.25
 */
 
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.js
@@ -37,9 +37,9 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ).ndarray;
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 *
-* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
+* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
 *
-* var v = dnanmean( 4, x, 2, 1 );
+* var v = dnanmean( 5, x, 2, 1 );
 * // returns 1.25
 */
 function dnanmean( N, x, strideX, offsetX ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dnanmean/lib/ndarray.native.js
@@ -37,9 +37,9 @@ var addon = require( './../src/addon.node' );
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 *
-* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
+* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
 *
-* var v = dnanmean( 4, x, 2, 1 );
+* var v = dnanmean( 5, x, 2, 1 );
 * // returns 1.25
 */
 function dnanmean( N, x, strideX, offsetX ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c b/lib/node_modules/@stdlib/stats/base/dnanmean/src/main.c
@@ -44,5 +44,5 @@ double API_SUFFIX(stdlib_strided_dnanmean)( const CBLAS_INT N, const double *X,
 * @return         output value
 */
 double API_SUFFIX(stdlib_strided_dnanmean_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) {
-	return stdlib_strided_dnanmeanpn_ndarray( N, X, strideX, offsetX );
+	return API_SUFFIX(stdlib_strided_dnanmeanpn_ndarray)( N, X, strideX, offsetX );
 }

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,9 @@`
`36`	`36`	`* var Float64Array = require( '@stdlib/array/float64' );`
`37`	`37`	`* var dnanmean = require( '@stdlib/stats/base/dnanmean' );`
`38`	`38`	`*`
`39`		`-* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );`
	`39`	`+* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );`
`40`	`40`	`*`
`41`		`-* var v = dnanmean.ndarray( 4, x, 2, 1 );`
	`41`	`+* var v = dnanmean.ndarray( 5, x, 2, 1 );`
`42`	`42`	`* // returns 1.25`
`43`	`43`	`*/`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,9 @@ var dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' ).ndarray;`
`37`	`37`	`* @example`
`38`	`38`	`* var Float64Array = require( '@stdlib/array/float64' );`
`39`	`39`	`*`
`40`		`-* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );`
	`40`	`+* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );`
`41`	`41`	`*`
`42`		`-* var v = dnanmean( 4, x, 2, 1 );`
	`42`	`+* var v = dnanmean( 5, x, 2, 1 );`
`43`	`43`	`* // returns 1.25`
`44`	`44`	`*/`
`45`	`45`	`function dnanmean( N, x, strideX, offsetX ) {`
Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,9 @@ var addon = require( './../src/addon.node' );`
`37`	`37`	`* @example`
`38`	`38`	`* var Float64Array = require( '@stdlib/array/float64' );`
`39`	`39`	`*`
`40`		`-* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );`
	`40`	`+* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );`
`41`	`41`	`*`
`42`		`-* var v = dnanmean( 4, x, 2, 1 );`
	`42`	`+* var v = dnanmean( 5, x, 2, 1 );`
`43`	`43`	`* // returns 1.25`
`44`	`44`	`*/`
`45`	`45`	`function dnanmean( N, x, strideX, offsetX ) {`