chore: minor clean up

Author: Neerajpathak07

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/README.md

@@ -77,7 +77,7 @@ var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN ] );
 
-var v = dsnanmeanpn( 5, x, 2 );
+var v = dsnanmeanpn( 4, x, 2 );
 // returns 1.25
 ```
 
@@ -90,6 +90,9 @@ var Float32Array = require( '@stdlib/array/float32' );
 
 var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
 var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+var v = dsnanmeanpn( 4, x1, 2 );
+// returns 1.25
 ```
 
 #### dsnanmeanpn.ndarray( N, x, strideX, offsetX )
@@ -107,14 +110,17 @@ var v = dsnanmeanpn.ndarray( x.length, x, 1, 0 );
 
 The function has the following additional parameters:
 
--   **offset**: starting index for `x`.
+-   **offsetX**: starting index for `x`.
 
 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
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
+
+var v = dsnanmeanpn.ndarray( 4, x, 2, 1 );
+// returns 1.25
 ```
 
 </section>
@@ -178,12 +184,12 @@ console.log( v );
 
 #### stdlib_strided_dsnanmeanpn( N, \*X, strideX )
 
-Calculate the Arithmetic Mean value of a double-precision floating-point strided array, ignoring `NaN` values.
+Calculate the arithmetic mean of a single-precision floating-point strided array `x` , ignoring `NaN` values, using a two-pass error correction algorithm with extended accumulation, and returning an extended precision result.
 
 ```c
 const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 3.0f, 0.0f/0.0f, 4.0f, 5.0f, 6.0f, 0.0f/0.0f, 7.0f, 8.0f, 0.0f/0.0f };
 
-double v = stdlib_strided_dsnanmeanpn( 5, x, 2 );
+double v = stdlib_strided_dsnanmeanpn( 6, x, 2 );
 // returns 1.25
 ```
 
@@ -199,12 +205,12 @@ double stdlib_strided_dsnanmeanpn( const CBLAS_INT N, const float *X, const CBLA
 
 #### stdlib_strided_dsnanmeanpn_ndarray( N, \*X, strideX, offsetX )
 
-Computes the Arithmetic Mean value of a double-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics.
+Computes the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm with extended accumulation and alternative indexing semantics.
 
 ```c
 const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 3.0f, 0.0f/0.0f, 4.0f, 5.0f, 6.0f, 0.0f/0.0f, 7.0f, 8.0f, 0.0f/0.0f };
 
-double v = stdlib_strided_dsnanmeanpn_ndarray( 5, x, 2, 0 );
+double v = stdlib_strided_dsnanmeanpn_ndarray( 6, x, 2, 0 );
 // returns 1.25
 ```
 
@@ -243,7 +249,7 @@ double stdlib_strided_dsnanmeanpn_ndarray( const CBLAS_INT N, const float *X, co
 
 int main( void ) {
     // Create a strided array:
-    const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 3.0f, 0.0f/0.0f, 4.0f, 5.0f, 6.0f, 0 0f/0.0f, 7.0f, 8.0f, 0.0f/0.0f };
+    const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 3.0f, 0.0f/0.0f, 4.0f, 5.0f, 6.0f, 0.0f/0.0f, 7.0f, 8.0f, 0.0f/0.0f };
 
     // Specify the number of elements:
     const int N = 6;

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/benchmark/benchmark.js

@@ -21,22 +21,29 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/array/uniform' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
 var dsnanmeanpn = require( './../lib/dsnanmeanpn.js' );
 
 
-// VARIABLES //
-
-var options = {
-	'dtype': 'float32'
-};
-
-
 // FUNCTIONS //
 
+/**
+* Returns a random value or `NaN`.
+*
+* @returns {number} random number or `NaN`
+*/
+function rand() {
+	if ( bernoulli( 0.2 ) ) {
+		return NaN;
+	}
+	return uniform( -10.0, 10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -45,7 +52,7 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = uniform( len, -10.0, 10.0, options );
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/benchmark/benchmark.native.js

@@ -22,7 +22,9 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/array/uniform' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var tryRequire = require( '@stdlib/utils/try-require' );
@@ -35,13 +37,22 @@ var dsnanmeanpn = tryRequire( resolve( __dirname, './../lib/dsnanmeanpn.native.j
 var opts = {
 	'skip': ( dsnanmeanpn instanceof Error )
 };
-var options = {
-	'dtype': 'float32'
-};
 
 
 // FUNCTIONS //
 
+/**
+* Returns a random value or `NaN`.
+*
+* @returns {number} random number or `NaN`
+*/
+function rand() {
+	if ( bernoulli( 0.2 ) ) {
+		return NaN;
+	}
+	return uniform( -10.0, 10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -50,7 +61,7 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = uniform( len, -10.0, 10.0, options );
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/benchmark/benchmark.ndarray.js

@@ -21,22 +21,29 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/array/uniform' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
 var dsnanmeanpn = require( './../lib/ndarray.js' );
 
 
-// VARIABLES //
-
-var options = {
-	'dtype': 'float32'
-};
-
-
 // FUNCTIONS //
 
+/**
+* Returns a random value or `NaN`.
+*
+* @returns {number} random number or `NaN`
+*/
+function rand() {
+	if ( bernoulli( 0.2 ) ) {
+		return NaN;
+	}
+	return uniform( -10.0, 10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -45,7 +52,7 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = uniform( len, -10.0, 10.0, options );
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/benchmark/benchmark.ndarray.native.js

@@ -22,7 +22,9 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var uniform = require( '@stdlib/random/array/uniform' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var tryRequire = require( '@stdlib/utils/try-require' );
@@ -35,13 +37,22 @@ var dsnanmeanpn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' )
 var opts = {
 	'skip': ( dsnanmeanpn instanceof Error )
 };
-var options = {
-	'dtype': 'float32'
-};
 
 
 // FUNCTIONS //
 
+/**
+* Returns a random value or `NaN`.
+*
+* @returns {number} random number or `NaN`
+*/
+function rand() {
+	if ( bernoulli( 0.2 ) ) {
+		return NaN;
+	}
+	return uniform( -10.0, 10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -50,7 +61,7 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = uniform( len, -10.0, 10.0, options );
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/benchmark/c/benchmark.length.c

@@ -97,14 +97,14 @@ static float rand_float( void ) {
 static double benchmark1( int iterations, int len ) {
 	double elapsed;
 	float x[ len ];
-	float v;
+	double v;
 	double t;
 	int i;
 
 	for ( i = 0; i < len; i++ ) {
 		x[ i ] = ( rand_float()*20000.0f ) - 10000.0f;
 	}
-	v = 0.0f;
+	v = 0.0;
 	t = tic();
 	for ( i = 0; i < iterations; i++ ) {
 		// cppcheck-suppress uninitvar
@@ -131,14 +131,14 @@ static double benchmark1( int iterations, int len ) {
 static double benchmark2( int iterations, int len ) {
 	double elapsed;
 	float x[ len ];
-	float v;
+	double v;
 	double t;
 	int i;
 
 	for ( i = 0; i < len; i++ ) {
 		x[ i ] = ( rand_float()*20000.0f ) - 10000.0f;
 	}
-	v = 0.0f;
+	v = 0.0;
 	t = tic();
 	for ( i = 0; i < iterations; i++ ) {
 		// cppcheck-suppress uninitvar

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/docs/repl.txt

@@ -4,8 +4,8 @@
     array, ignoring `NaN` values, using a two-pass error correction algorithm
     with extended accumulation, and returning an extended precision result.
 
-    The `N` and stride parameters determine which elements in `x` are accessed
-    at runtime.
+    The `N` and stride parameters determine which elements in the strided array
+    are accessed at runtime.
 
     Indexing is relative to the first index. To introduce an offset, use a typed
     array view.
@@ -23,7 +23,7 @@
         Input array.
 
     strideX: integer
-        Stride Length.
+        Stride length.
 
     Returns
     -------
@@ -37,16 +37,14 @@
     > {{alias}}( x.length, x, 1 )
     ~0.3333
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and stride parameters:
     > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ] );
     > {{alias}}( 3, x, 2 )
     ~0.3333
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] );
     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > stride = 2;
     > {{alias}}( 3, x1, 2 )
     ~-0.3333
 
@@ -69,7 +67,7 @@
         Input array.
 
     strideX: integer
-        Stride Length.
+        Stride length.
 
     offsetX: integer
         Starting index.

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/examples/index.js

@@ -18,12 +18,22 @@
 
 'use strict';
 
-var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var randu = require( '@stdlib/random/base/randu' );
+var round = require( '@stdlib/math/base/special/round' );
+var Float32Array = require( '@stdlib/array/float32' );
 var dsnanmeanpn = require( './../lib' );
 
-var x = discreteUniform( 10, -50, 50, {
-	'dtype': 'float32'
-});
+var x;
+var i;
+
+x = new Float32Array( 10 );
+for ( i = 0; i < x.length; i++ ) {
+    if ( randu() < 0.2 ) {
+        x[ i ] = NaN;
+    } else {
+        x[ i ] = round( (randu()*100.0) - 50.0 );
+    }
+}
 console.log( x );
 
 var v = dsnanmeanpn( x.length, x, 1 );

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/include/stdlib/stats/base/dsnanmeanpn.h

@@ -34,7 +34,7 @@ extern "C" {
 double API_SUFFIX(stdlib_strided_dsnanmeanpn)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX );
 
 /**
-* Computes the arithmetic mean value of a single-precision floating-point strided array using alternative indexing semantics.
+* Computes the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm with extended accumulation and alternative indexing semantics.
 */
 double API_SUFFIX(stdlib_strided_dsnanmeanpn_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
 

lib/node_modules/@stdlib/stats/base/dsnanmeanpn/lib/index.js

@@ -38,7 +38,7 @@
 *
 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] );
 *
-* var v = dsnanmeanpn.ndarray( 5, x, 2, 1 );
+* var v = dsnanmeanpn.ndarray( 4, x, 2, 1 );
 * // returns 1.25
 */