revert: docs: fix example code

Planeshifter · Planeshifter · commit 168c7c18aa58 · 2025-08-22T14:00:37.000-05:00
This reverts commit e4701e8. Keep changes to `stats/strided/meanpw`, `stats/strided/nanmeanwd`, and `stats/base/ndarray/min-by` only.
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dztest/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dztest/lib/index.js
@@ -56,7 +56,7 @@
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = dztest( [ x, out, alt, alpha, mu, sigma ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dztest/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/dztest/lib/main.js
@@ -79,7 +79,7 @@ var strided = require( '@stdlib/stats/strided/dztest' ).ndarray;
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = dztest( [ x, out, alt, alpha, mu, sigma ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dztest2/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dztest2/lib/index.js
@@ -60,7 +60,7 @@
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = dztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dztest2/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/dztest2/lib/main.js
@@ -85,7 +85,7 @@ var strided = require( '@stdlib/stats/strided/dztest2' ).ndarray;
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = dztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sztest/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/sztest/lib/index.js
@@ -56,7 +56,7 @@
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float32Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float32Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = sztest( [ x, out, alt, alpha, mu, sigma ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sztest/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/sztest/lib/main.js
@@ -79,7 +79,7 @@ var strided = require( '@stdlib/stats/strided/sztest' ).ndarray;
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float32Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float32Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = sztest( [ x, out, alt, alpha, mu, sigma ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sztest2/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/sztest2/lib/index.js
@@ -60,7 +60,7 @@
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float32Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float32Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = sztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sztest2/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/sztest2/lib/main.js
@@ -85,7 +85,7 @@ var strided = require( '@stdlib/stats/strided/sztest2' ).ndarray;
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float32Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float32Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = sztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/ztest/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/ztest/lib/index.js
@@ -55,7 +55,7 @@
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = ztest( [ x, out, alt, alpha, mu, sigma ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/ztest/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/ztest/lib/main.js
@@ -78,7 +78,7 @@ var strided = require( '@stdlib/stats/strided/ztest' ).ndarray;
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = ztest( [ x, out, alt, alpha, mu, sigma ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/ztest2/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/ztest2/lib/index.js
@@ -59,7 +59,7 @@
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = ztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/ztest2/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/ztest2/lib/main.js
@@ -84,7 +84,7 @@ var strided = require( '@stdlib/stats/strided/ztest2' ).ndarray;
 *
 * // Create a zero-dimensional results ndarray:
 * var ResultsArray = structFactory( Float64Results );
-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );
 *
 * // Perform a Z-test:
 * var v = ztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );
diff --git a/lib/node_modules/@stdlib/stats/strided/dvarm/lib/index.js b/lib/node_modules/@stdlib/stats/strided/dvarm/lib/index.js
@@ -30,7 +30,7 @@
 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 *
 * var v = dvarm( x.length, 1, 1.0/3.0, x, 1 );
-* // returns 3.25
+* // returns ~4.3333
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
@@ -39,7 +39,7 @@
 * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 *
 * var v = dvarm.ndarray( 4, 1, 1.25, x, 2, 1 );
-* // returns ~6.82
+* // returns 6.25
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/stats/strided/dvarmpn/lib/index.js b/lib/node_modules/@stdlib/stats/strided/dvarmpn/lib/index.js
@@ -30,7 +30,7 @@
 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 *
 * var v = dvarmpn( x.length, 1, 1.0/3.0, x, 1 );
-* // returns 3.25
+* // returns ~4.3333
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
@@ -39,7 +39,7 @@
 * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 *
 * var v = dvarmpn.ndarray( 4, 1, 1.25, x, 2, 1 );
-* // returns 6.818181818181818
+* // returns 6.25
 */
 
 // MODULES //

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@`
`56`	`56`	`*`
`57`	`57`	`* // Create a zero-dimensional results ndarray:`
`58`	`58`	`* var ResultsArray = structFactory( Float64Results );`
`59`		`-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
	`59`	`+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
`60`	`60`	`*`
`61`	`61`	`* // Perform a Z-test:`
`62`	`62`	`* var v = dztest( [ x, out, alt, alpha, mu, sigma ] );`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ var strided = require( '@stdlib/stats/strided/dztest' ).ndarray;`
`79`	`79`	`*`
`80`	`80`	`* // Create a zero-dimensional results ndarray:`
`81`	`81`	`* var ResultsArray = structFactory( Float64Results );`
`82`		`-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
	`82`	`+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
`83`	`83`	`*`
`84`	`84`	`* // Perform a Z-test:`
`85`	`85`	`* var v = dztest( [ x, out, alt, alpha, mu, sigma ] );`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@`
`60`	`60`	`*`
`61`	`61`	`* // Create a zero-dimensional results ndarray:`
`62`	`62`	`* var ResultsArray = structFactory( Float64Results );`
`63`		`-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
	`63`	`+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
`64`	`64`	`*`
`65`	`65`	`* // Perform a Z-test:`
`66`	`66`	`* var v = dztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ var strided = require( '@stdlib/stats/strided/dztest2' ).ndarray;`
`85`	`85`	`*`
`86`	`86`	`* // Create a zero-dimensional results ndarray:`
`87`	`87`	`* var ResultsArray = structFactory( Float64Results );`
`88`		`-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
	`88`	`+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
`89`	`89`	`*`
`90`	`90`	`* // Perform a Z-test:`
`91`	`91`	`* var v = dztest2( [ x, y, out, alt, alpha, diff, sigmax, sigmay ] );`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@`
`55`	`55`	`*`
`56`	`56`	`* // Create a zero-dimensional results ndarray:`
`57`	`57`	`* var ResultsArray = structFactory( Float64Results );`
`58`		`-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
	`58`	`+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
`59`	`59`	`*`
`60`	`60`	`* // Perform a Z-test:`
`61`	`61`	`* var v = ztest( [ x, out, alt, alpha, mu, sigma ] );`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ var strided = require( '@stdlib/stats/strided/ztest' ).ndarray;`
`78`	`78`	`*`
`79`	`79`	`* // Create a zero-dimensional results ndarray:`
`80`	`80`	`* var ResultsArray = structFactory( Float64Results );`
`81`		`-* var out = new ndarray( 'generic', new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
	`81`	`+* var out = new ndarray( Float64Results, new ResultsArray( 1 ), [], [ 0 ], 0, 'row-major' );`
`82`	`82`	`*`
`83`	`83`	`* // Perform a Z-test:`
`84`	`84`	`* var v = ztest( [ x, out, alt, alpha, mu, sigma ] );`