refactor: update parameter orders

Author: gururaj1512

lib/node_modules/@stdlib/stats/strided/ztest2/README.md

@@ -46,7 +46,7 @@ Here, `μX` and `μY` are the true population means of samples `X` and `Y`, resp
 var ztest2 = require( '@stdlib/stats/strided/ztest2' );
 ```
 
-#### ztest2( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, y, strideY, out )
+#### ztest2( NX, NY, alternative, alpha, diff, sigmax, x, strideX, sigmay, y, strideY, out )
 
 Computes a two-sample Z-test.
 
@@ -57,7 +57,7 @@ var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
 var y = [ 3.0, 3.0, 5.0, 7.0, 7.0 ];
 
 var results = new Results();
-var out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, results );
+var out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, results );
 // returns {...}
 
 var bool = ( out === results );
@@ -72,9 +72,9 @@ The function has the following parameters:
 -   **alpha**: significance level.
 -   **diff**: difference in means under the null hypothesis.
 -   **sigmax**: known standard deviation of `x`.
--   **sigmay**: known standard deviation of `y`.
 -   **x**: input array.
 -   **strideX**: stride length for `x`.
+-   **sigmay**: known standard deviation of `y`.
 -   **y**: input array.
 -   **strideY**: stride length for `y`.
 -   **out**: output [results object][@stdlib/stats/base/ztest/two-sample/results/float64].
@@ -88,7 +88,7 @@ var x = [ 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0, 0.0 ];
 var y = [ 3.0, 0.0, 3.0, 0.0, 5.0, 0.0, 7.0, 0.0, 7.0, 0.0 ];
 
 var results = new Results();
-var out = ztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 2, y, 2, results );
+var out = ztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, 2.0, y, 2, results );
 // returns {...}
 
 var bool = ( out === results );
@@ -110,14 +110,14 @@ var y0 = new Float64Array( [ 0.0, 3.0, 3.0, 5.0, 7.0, 7.0 ] );
 var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
 var results = new Results();
-var out = ztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, 2.0, x1, 1, y1, 1, results );
+var out = ztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, x1, 1, 2.0, y1, 1, results );
 // returns {...}
 
 var bool = ( out === results );
 // returns true
 ```
 
-#### ztest2.ndarray( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, offsetX, y, strideY, offsetY, out )
+#### ztest2.ndarray( NX, NY, alternative, alpha, diff, sigmax, x, strideX, offsetX, sigmay, y, strideY, offsetY, out )
 
 Computes a two-sample Z-test using alternative indexing semantics.
 
@@ -128,7 +128,7 @@ var x = [ 4.0, 4.0, 6.0, 6.0, 5.0 ];
 var y = [ 3.0, 3.0, 5.0, 7.0, 7.0 ];
 
 var results = new Results();
-var out = ztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, results );
+var out = ztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, results );
 // returns {...}
 
 var bool = ( out === results );
@@ -149,7 +149,7 @@ var x = [ 0.0, 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0 ];
 var y = [ 0.0, 3.0, 0.0, 3.0, 0.0, 5.0, 0.0, 7.0, 0.0, 7.0 ];
 
 var results = new Results();
-var out = ztest2.ndarray( 5, 5, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 2, 1, y, 2, 1, results );
+var out = ztest2.ndarray( 5, 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, 1, 2.0, y, 2, 1, results );
 // returns {...}
 
 var bool = ( out === results );
@@ -191,7 +191,7 @@ var y = normal( 800, 3.0, 2.0, {
 });
 
 var results = new Results();
-var out = ztest2( x.length, y.length, 'two-sided', 0.05, 1.0, 2.0, 2.0, x, 1, y, 1, results );
+var out = ztest2( x.length, y.length, 'two-sided', 0.05, 1.0, 2.0, x, 1, 2.0, y, 1, results );
 // returns {...}
 
 console.log( out.toString() );

lib/node_modules/@stdlib/stats/strided/ztest2/benchmark/benchmark.js

@@ -62,7 +62,7 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 1.0, x, 1, y, 1, results );
+			out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 1.0, y, 1, results );
 			if ( isnan( out.statistic ) ) {
 				b.fail( 'should not return NaN' );
 			}

lib/node_modules/@stdlib/stats/strided/ztest2/benchmark/benchmark.ndarray.js

@@ -62,7 +62,7 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 1.0, x, 1, 0, y, 1, 0, results );
+			out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, 1.0, y, 1, 0, results );
 			if ( isnan( out.statistic ) ) {
 				b.fail( 'should not return NaN' );
 			}

lib/node_modules/@stdlib/stats/strided/ztest2/docs/repl.txt

@@ -1,5 +1,5 @@
 
-{{alias}}( NX, NY, alt, alpha, diff, sigmax, sigmay, x, sx, y, sy, out )
+{{alias}}( NX, NY, alt, alpha, diff, sigmax, x, sx, sigmay, y, sy, out )
     Computes a two-sample Z-test.
 
     The `N` and stride parameters determine which elements in the strided array
@@ -32,15 +32,15 @@
     sigmax: number
         Known standard deviation of `x`.
 
-    sigmay: number
-        Known standard deviation of `y`.
-
     x: Array|TypedArray|Object
         Input array.
 
     strideX: integer
         Stride length for `x`.
 
+    sigmay: number
+        Known standard deviation of `y`.
+
     y: Array|TypedArray|Object
         Input array.
 
@@ -63,11 +63,11 @@
     > var NY = y.length;
     > var alt = 'two-sided';
     > var out = new {{alias:@stdlib/stats/base/ztest/two-sample/results/float64}}();
-    > var res = {{alias}}( NX, NY, alt, 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, out );
+    > var res = {{alias}}( NX, NY, alt, 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, out );
     > res.toString()
 
 
-{{alias}}.ndarray( NX, NY, alt, alpha, diff, sigmax, sigmay, x, sx, ox, y, sy, oy, out )
+{{alias}}.ndarray( NX, NY, alt, alpha, diff, sigmax, x, sx, ox, sigmay, y, sy, oy, out )
     Computes a two-sample Z-test using alternative indexing semantics.
 
     While typed array views mandate a view offset based on the underlying
@@ -98,9 +98,6 @@
     sigmax: number
         Known standard deviation of `x`.
 
-    sigmay: number
-        Known standard deviation of `y`.
-
     x: Array|TypedArray|Object
         Input array.
 
@@ -110,6 +107,9 @@
     offsetX: integer
         Starting index for `x`.
 
+    sigmay: number
+        Known standard deviation of `y`.
+
     y: Array|TypedArray|Object
         Input array.
 
@@ -135,7 +135,7 @@
     > var NY = y.length;
     > var alt = 'two-sided';
     > var out = new {{alias:@stdlib/stats/base/ztest/two-sample/results/float64}}();
-    > var res = {{alias}}.ndarray( NX, NY, alt, 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, out );
+    > var res = {{alias}}.ndarray( NX, NY, alt, 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, out );
     > res.toString()
 
     See Also

lib/node_modules/@stdlib/stats/strided/ztest2/docs/types/index.d.ts

@@ -139,9 +139,9 @@ interface Routine {
 	* @param alpha - significance level
 	* @param diff - difference in means under the null hypothesis
 	* @param sigmax - known standard deviation of `x`
-	* @param sigmay - known standard deviation of `y`
 	* @param x - input array
 	* @param strideX - stride length for `x`
+	* @param sigmay - known standard deviation of `y`
 	* @param y - input array
 	* @param strideY - stride length for `y`
 	* @param out - output results object
@@ -154,13 +154,13 @@ interface Routine {
 	* var y = [ 3.0, 3.0, 5.0, 7.0, 7.0 ];
 	*
 	* var results = new Results();
-	* var out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, results );
+	* var out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, results );
 	* // returns {...}
 	*
 	* var bool = ( out === results );
 	* // returns true
 	*/
-	<T extends BaseResults>( NX: number, NY: number, alternative: Alternative, alpha: number, diff: number, sigmax: number, sigmay: number, x: InputArray, strideX: number, y: InputArray, strideY: number, out: T ): Results;
+	<T extends BaseResults>( NX: number, NY: number, alternative: Alternative, alpha: number, diff: number, sigmax: number, x: InputArray, strideX: number, sigmay: number, y: InputArray, strideY: number, out: T ): Results;
 
 	/**
 	* Computes a two-sample Z-test using alternative indexing semantics.
@@ -171,10 +171,10 @@ interface Routine {
 	* @param alpha - significance level
 	* @param diff - difference in means under the null hypothesis
 	* @param sigmax - known standard deviation of `x`
-	* @param sigmay - known standard deviation of `y`
 	* @param x - input array
 	* @param strideX - stride length for `x`
 	* @param offsetX - starting index for `x`
+	* @param sigmay - known standard deviation of `y`
 	* @param y - input array
 	* @param strideY - stride length for `y`
 	* @param offsetY - starting index for `y`
@@ -188,13 +188,13 @@ interface Routine {
 	* var y = [ 3.0, 3.0, 5.0, 7.0, 7.0 ];
 	*
 	* var results = new Results();
-	* var out = ztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, results );
+	* var out = ztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, results );
 	* // returns {...}
 	*
 	* var bool = ( out === results );
 	* // returns true
 	*/
-	ndarray<T extends BaseResults>( NX: number, NY: number, alternative: Alternative, alpha: number, diff: number, sigmax: number, sigmay: number, x: InputArray, strideX: number, offsetX: number, y: InputArray, strideY: number, offsetY: number, out: T ): Results;
+	ndarray<T extends BaseResults>( NX: number, NY: number, alternative: Alternative, alpha: number, diff: number, sigmax: number, x: InputArray, strideX: number, offsetX: number, sigmay: number, y: InputArray, strideY: number, offsetY: number, out: T ): Results;
 }
 
 /**
@@ -206,9 +206,9 @@ interface Routine {
 * @param alpha - significance level
 * @param diff - difference in means under the null hypothesis
 * @param sigmax - known standard deviation of `x`
-* @param sigmay - known standard deviation of `y`
 * @param x - input array
 * @param strideX - stride length for `x`
+* @param sigmay - known standard deviation of `y`
 * @param y - input array
 * @param strideY - stride length for `y`
 * @param out - output results object
@@ -221,7 +221,7 @@ interface Routine {
 * var y = [ 3.0, 3.0, 5.0, 7.0, 7.0 ];
 *
 * var results = new Results();
-* var out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, results );
+* var out = ztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, results );
 * // returns {...}
 *
 * var bool = ( out === results );
@@ -234,7 +234,7 @@ interface Routine {
 * var y = [ 3.0, 3.0, 5.0, 7.0, 7.0 ];
 *
 * var results = new Results();
-* var out = ztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, results );
+* var out = ztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, results );
 * // returns {...}
 *
 * var bool = ( out === results );