Skip to content

Commit 7fa3913

Browse files
committed
refactor: update parameter orders
1 parent 79c85fb commit 7fa3913

File tree

11 files changed

+74
-74
lines changed

11 files changed

+74
-74
lines changed

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

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Here, `μX` and `μY` are the true population means of samples `X` and `Y`, resp
4646
var dztest2 = require( '@stdlib/stats/strided/dztest2' );
4747
```
4848

49-
#### dztest2( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, y, strideY, out )
49+
#### dztest2( NX, NY, alternative, alpha, diff, sigmax, x, strideX, sigmay, y, strideY, out )
5050

5151
Computes a two-sample Z-test for double-precision floating-point strided arrays.
5252

@@ -58,7 +58,7 @@ var x = new Float64Array( [ 4.0, 4.0, 6.0, 6.0, 5.0 ] );
5858
var y = new Float64Array( [ 3.0, 3.0, 5.0, 7.0, 7.0 ] );
5959

6060
var results = new Results();
61-
var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, results );
61+
var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, results );
6262
// returns {...}
6363

6464
var bool = ( out === results );
@@ -73,14 +73,14 @@ The function has the following parameters:
7373
- **alpha**: significance level.
7474
- **diff**: difference in means under the null hypothesis.
7575
- **sigmax**: known standard deviation of `x`.
76-
- **sigmay**: known standard deviation of `y`.
77-
- **x**: input [`Float64Array`][@stdlib/array/float64].
76+
- **x**: first input [`Float64Array`][@stdlib/array/float64].
7877
- **strideX**: stride length for `x`.
79-
- **y**: input [`Float64Array`][@stdlib/array/float64].
78+
- **sigmay**: known standard deviation of `y`.
79+
- **y**: second input [`Float64Array`][@stdlib/array/float64].
8080
- **strideY**: stride length for `y`.
8181
- **out**: output [results object][@stdlib/stats/base/ztest/two-sample/results/float64].
8282

83-
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to perform a two-sample Z-test over every other element in `x` and `y`,
83+
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to perform a two-sample Z-test over every other element in `x` and `y`,
8484

8585
```javascript
8686
var Results = require( '@stdlib/stats/base/ztest/two-sample/results/float64' );
@@ -90,7 +90,7 @@ var x = new Float64Array( [ 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0, 0.0 ] )
9090
var y = new Float64Array( [ 3.0, 0.0, 3.0, 0.0, 5.0, 0.0, 7.0, 0.0, 7.0, 0.0 ] );
9191

9292
var results = new Results();
93-
var out = dztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 2, y, 2, results );
93+
var out = dztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, 2.0, y, 2, results );
9494
// returns {...}
9595

9696
var bool = ( out === results );
@@ -112,14 +112,14 @@ var y0 = new Float64Array( [ 0.0, 3.0, 3.0, 5.0, 7.0, 7.0 ] );
112112
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
113113

114114
var results = new Results();
115-
var out = dztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, 2.0, x1, 1, y1, 1, results );
115+
var out = dztest2( 5, 5, 'two-sided', 0.05, 0.0, 1.0, x1, 1, 2.0, y1, 1, results );
116116
// returns {...}
117117

118118
var bool = ( out === results );
119119
// returns true
120120
```
121121

122-
#### dztest2.ndarray( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, offsetX, y, strideY, offsetY, out )
122+
#### dztest2.ndarray( NX, NY, alternative, alpha, diff, sigmax, x, strideX, offsetX, sigmay, y, strideY, offsetY, out )
123123

124124
Computes a two-sample Z-test for double-precision floating-point strided arrays using alternative indexing semantics.
125125

@@ -131,7 +131,7 @@ var x = new Float64Array( [ 4.0, 4.0, 6.0, 6.0, 5.0 ] );
131131
var y = new Float64Array( [ 3.0, 3.0, 5.0, 7.0, 7.0 ] );
132132

133133
var results = new Results();
134-
var out = dztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, results );
134+
var out = dztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, results );
135135
// returns {...}
136136

137137
var bool = ( out === results );
@@ -153,7 +153,7 @@ var x = new Float64Array( [ 0.0, 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0 ] )
153153
var y = new Float64Array( [ 0.0, 3.0, 0.0, 3.0, 0.0, 5.0, 0.0, 7.0, 0.0, 7.0 ] );
154154

155155
var results = new Results();
156-
var out = dztest2.ndarray( 5, 5, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 2, 1, y, 2, 1, results );
156+
var out = dztest2.ndarray( 5, 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, 1, 2.0, y, 2, 1, results );
157157
// returns {...}
158158

159159
var bool = ( out === results );
@@ -168,7 +168,7 @@ var bool = ( out === results );
168168

169169
## Notes
170170

171-
- As a general rule of thumb, a Z-test is most reliable when `N >= 50`. For smaller sample sizes or when the standard deviation is unknown, prefer a t-test.
171+
- As a general rule of thumb, a Z-test is most reliable when `N >= 50`. For smaller sample sizes or when the standard deviations are unknown, prefer a t-test.
172172

173173
</section>
174174

@@ -193,7 +193,7 @@ var y = normal( 800, 3.0, 2.0, {
193193
});
194194

195195
var results = new Results();
196-
var out = dztest2( x.length, y.length, 'two-sided', 0.05, 1.0, 2.0, 2.0, x, 1, y, 1, results );
196+
var out = dztest2( x.length, y.length, 'two-sided', 0.05, 1.0, 2.0, x, 1, 2.0, y, 1, results );
197197
// returns {...}
198198

199199
console.log( out.toString() );
@@ -229,7 +229,7 @@ console.log( out.toString() );
229229
#include "stdlib/stats/strided/dztest2.h"
230230
```
231231

232-
#### stdlib_strided_dztest2( NX, NY, alternative, alpha, diff, sigmax, sigmay, \*X, strideX, \*Y, strideY, \*results )
232+
#### stdlib_strided_dztest2( NX, NY, alternative, alpha, diff, sigmax, \*X, strideX, sigmay, \*Y, strideY, \*results )
233233

234234
Computes a two-sample Z-test for double-precision floating-point strided arrays.
235235

@@ -252,7 +252,7 @@ struct stdlib_stats_ztest_two_sample_float64_results results = {
252252
const double x[] = { 4.0, 4.0, 6.0, 6.0, 5.0 };
253253
const double y[] = { 3.0, 3.0, 5.0, 7.0, 7.0 };
254254

255-
stdlib_strided_dztest2( 5, 5, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, &results );
255+
stdlib_strided_dztest2( 5, 5, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, &results );
256256
```
257257
258258
The function accepts the following arguments:
@@ -263,18 +263,18 @@ The function accepts the following arguments:
263263
- **alpha**: `[in] double` significance level.
264264
- **diff**: `[in] double` difference in means under the null hypothesis.
265265
- **sigmax** `[in] double` known standard deviation of `x`.
266-
- **sigmay** `[in] double` known standard deviation of `y`.
267-
- **X**: `[in] double*` input [`Float64Array`][@stdlib/array/float64].
266+
- **X**: `[in] double*` first input [`Float64Array`][@stdlib/array/float64].
268267
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
269-
- **Y**: `[in] double*` input [`Float64Array`][@stdlib/array/float64].
268+
- **sigmay** `[in] double` known standard deviation of `y`.
269+
- **Y**: `[in] double*` second input [`Float64Array`][@stdlib/array/float64].
270270
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
271271
- **results**: `[out] struct stdlib_stats_ztest_two_sample_results_float64*` output [results object][@stdlib/stats/base/ztest/two-sample/results/float64].
272272
273273
```c
274-
void stdlib_strided_dztest2( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double sigmay, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY, struct stdlib_stats_ztest_two_sample_float64_results *results );
274+
void stdlib_strided_dztest2( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double *X, const CBLAS_INT strideX, const double sigmay, const double *Y, const CBLAS_INT strideY, struct stdlib_stats_ztest_two_sample_float64_results *results );
275275
```
276276

277-
#### stdlib_strided_dztest2_ndarray( NX, NY, alternative, alpha, diff, sigmax, sigmay, \*X, strideX, offsetX, \*Y, strideY, offsetY, \*results )
277+
#### stdlib_strided_dztest2_ndarray( NX, NY, alternative, alpha, diff, sigmax, \*X, strideX, offsetX, sigmay, \*Y, strideY, offsetY, \*results )
278278

279279
Computes a two-sample Z-test for double-precision floating-point strided arrays using alternative indexing semantics.
280280

@@ -297,7 +297,7 @@ struct stdlib_stats_ztest_two_sample_float64_results results = {
297297
const double x[] = { 4.0, 4.0, 6.0, 6.0, 5.0 };
298298
const double y[] = { 3.0, 3.0, 5.0, 7.0, 7.0 };
299299

300-
stdlib_strided_dztest2_ndarray( 5, 5, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, &results );
300+
stdlib_strided_dztest2_ndarray( 5, 5, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, &results );
301301
```
302302
303303
The function accepts the following arguments:
@@ -308,17 +308,17 @@ The function accepts the following arguments:
308308
- **alpha**: `[in] double` significance level.
309309
- **diff**: `[in] double` difference in means under the null hypothesis.
310310
- **sigmax** `[in] double` known standard deviation of `x`.
311-
- **sigmay** `[in] double` known standard deviation of `y`.
312-
- **X**: `[in] double*` input [`Float64Array`][@stdlib/array/float64].
311+
- **X**: `[in] double*` first input [`Float64Array`][@stdlib/array/float64].
313312
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
314313
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
315-
- **Y**: `[in] double*` input [`Float64Array`][@stdlib/array/float64].
314+
- **sigmay** `[in] double` known standard deviation of `y`.
315+
- **Y**: `[in] double*` second input [`Float64Array`][@stdlib/array/float64].
316316
- **strideY**: `[in] CBLAS_INT` stride length for `Y`.
317317
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
318318
- **results**: `[out] struct stdlib_stats_ztest_two_sample_results_float64*` output [results object][@stdlib/stats/base/ztest/two-sample/results/float64].
319319
320320
```c
321-
void stdlib_strided_dztest2_ndarray( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double sigmay, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, struct stdlib_stats_ztest_two_sample_float64_results *results );
321+
void stdlib_strided_dztest2_ndarray( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double sigmay, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, struct stdlib_stats_ztest_two_sample_float64_results *results );
322322
```
323323

324324
</section>
@@ -373,7 +373,7 @@ int main( void ) {
373373
};
374374

375375
// Compute a Z-test:
376-
stdlib_strided_dztest2( NX, NY, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 5.0, 3.0, 3.0, x, strideX, y, strideY, &results );
376+
stdlib_strided_dztest2( NX, NY, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 5.0, 3.0, x, strideX, 3.0, y, strideY, &results );
377377

378378
// Print the result:
379379
printf( "Statistic: %lf\n", results.statistic );

lib/node_modules/@stdlib/stats/strided/dztest2/examples/c/example.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ int main( void ) {
4949
};
5050

5151
// Compute a Z-test:
52-
stdlib_strided_dztest2( NX, NY, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 5.0, 3.0, 3.0, x, strideX, y, strideY, &results );
52+
stdlib_strided_dztest2( NX, NY, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05, 5.0, 3.0, x, strideX, 3.0, y, strideY, &results );
5353

5454
// Print the result:
5555
printf( "Statistic: %lf\n", results.statistic );

lib/node_modules/@stdlib/stats/strided/dztest2/examples/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var y = normal( 800, 3.0, 2.0, {
3030
});
3131

3232
var results = new Results();
33-
var out = dztest2( x.length, y.length, 'two-sided', 0.05, 1.0, 2.0, 2.0, x, 1, y, 1, results );
33+
var out = dztest2( x.length, y.length, 'two-sided', 0.05, 1.0, 2.0, x, 1, 2.0, y, 1, results );
3434
// returns {...}
3535

3636
console.log( out.toString() );

lib/node_modules/@stdlib/stats/strided/dztest2/include/stdlib/stats/strided/dztest2.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ extern "C" {
3333
/**
3434
* Computes a two-sample Z-test for double-precision floating-point strided arrays.
3535
*/
36-
void API_SUFFIX(stdlib_strided_dztest2)( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double sigmay, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY, struct stdlib_stats_ztest_two_sample_float64_results *results );
36+
void API_SUFFIX(stdlib_strided_dztest2)( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double *X, const CBLAS_INT strideX, const double sigmay, const double *Y, const CBLAS_INT strideY, struct stdlib_stats_ztest_two_sample_float64_results *results );
3737

3838
/**
3939
* Computes a two-sample Z-test for double-precision floating-point strided arrays using alternative indexing semantics.
4040
*/
41-
void API_SUFFIX(stdlib_strided_dztest2_ndarray)( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double sigmay, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, struct stdlib_stats_ztest_two_sample_float64_results *results );
41+
void API_SUFFIX(stdlib_strided_dztest2_ndarray)( const CBLAS_INT NX, const CBLAS_INT NY, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const double alpha, const double diff, const double sigmax, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double sigmay, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, struct stdlib_stats_ztest_two_sample_float64_results *results );
4242

4343
#ifdef __cplusplus
4444
}

lib/node_modules/@stdlib/stats/strided/dztest2/lib/dztest2.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ var ndarray = require( './ndarray.js' );
3535
* @param {number} alpha - significance level
3636
* @param {number} diff - difference in means under the null hypothesis
3737
* @param {PositiveNumber} sigmax - known standard deviation of `x`
38-
* @param {PositiveNumber} sigmay - known standard deviation of `y`
39-
* @param {Float64Array} x - input array
38+
* @param {Float64Array} x - first input array
4039
* @param {integer} strideX - stride length for `x`
41-
* @param {Float64Array} y - input array
40+
* @param {PositiveNumber} sigmay - known standard deviation of `y`
41+
* @param {Float64Array} y - second input array
4242
* @param {integer} strideY - stride length for `y`
4343
* @param {Object} out - output results object
4444
* @returns {Object} results object
@@ -51,14 +51,14 @@ var ndarray = require( './ndarray.js' );
5151
* var y = new Float64Array( [ 3.0, 3.0, 5.0, 7.0, 7.0 ] );
5252
*
5353
* var results = new Results();
54-
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, results );
54+
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, results );
5555
* // returns {...}
5656
*
5757
* var bool = ( out === results );
5858
* // returns true
5959
*/
60-
function dztest2( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, y, strideY, out ) { // eslint-disable-line max-len, max-params
61-
return ndarray( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, stride2offset( NX, strideX ), y, strideY, stride2offset( NY, strideY ), out ); // eslint-disable-line max-len
60+
function dztest2( NX, NY, alternative, alpha, diff, sigmax, x, strideX, sigmay, y, strideY, out ) { // eslint-disable-line max-len, max-params
61+
return ndarray( NX, NY, alternative, alpha, diff, sigmax, x, strideX, stride2offset( NX, strideX ), sigmay, y, strideY, stride2offset( NY, strideY ), out ); // eslint-disable-line max-len
6262
}
6363

6464

lib/node_modules/@stdlib/stats/strided/dztest2/lib/dztest2.native.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ var addon = require( './../src/addon.node' );
3535
* @param {number} alpha - significance level
3636
* @param {number} diff - difference in means under the null hypothesis
3737
* @param {PositiveNumber} sigmax - known standard deviation of `x`
38-
* @param {PositiveNumber} sigmay - known standard deviation of `y`
39-
* @param {Float64Array} x - input array
38+
* @param {Float64Array} x - first input array
4039
* @param {integer} strideX - stride length for `x`
41-
* @param {Float64Array} y - input array
40+
* @param {PositiveNumber} sigmay - known standard deviation of `y`
41+
* @param {Float64Array} y - second input array
4242
* @param {integer} strideY - stride length for `y`
4343
* @param {Object} out - output results object
4444
* @returns {Object} results object
@@ -51,14 +51,14 @@ var addon = require( './../src/addon.node' );
5151
* var y = new Float64Array( [ 3.0, 3.0, 5.0, 7.0, 7.0 ] );
5252
*
5353
* var results = new Results();
54-
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, results );
54+
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, results );
5555
* // returns {...}
5656
*
5757
* var bool = ( out === results );
5858
* // returns true
5959
*/
60-
function dztest2( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, y, strideY, out ) { // eslint-disable-line max-len, max-params
61-
addon( NX, NY, resolveEnum( alternative ), alpha, diff, sigmax, sigmay, x, strideX, y, strideY, out.toDataView() ); // eslint-disable-line max-len
60+
function dztest2( NX, NY, alternative, alpha, diff, sigmax, x, strideX, sigmay, y, strideY, out ) { // eslint-disable-line max-len, max-params
61+
addon( NX, NY, resolveEnum( alternative ), alpha, diff, sigmax, x, strideX, sigmay, y, strideY, out.toDataView() ); // eslint-disable-line max-len
6262
return out;
6363
}
6464

lib/node_modules/@stdlib/stats/strided/dztest2/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
* var y = new Float64Array( [ 3.0, 3.0, 5.0, 7.0, 7.0 ] );
3333
*
3434
* var results = new Results();
35-
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, y, 1, results );
35+
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 2.0, y, 1, results );
3636
* // returns {...}
3737
*
3838
* var bool = ( out === results );
@@ -47,7 +47,7 @@
4747
* var y = new Float64Array( [ 3.0, 3.0, 5.0, 7.0, 7.0 ] );
4848
*
4949
* var results = new Results();
50-
* var out = dztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, results );
50+
* var out = dztest2.ndarray( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, results );
5151
* // returns {...}
5252
*
5353
* var bool = ( out === results );

lib/node_modules/@stdlib/stats/strided/dztest2/lib/ndarray.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ var WORKSPACE = new Float64Array( 2 );
5252
* @param {number} alpha - significance level
5353
* @param {number} diff - difference in means under the null hypothesis
5454
* @param {PositiveNumber} sigmax - known standard deviation of `x`
55-
* @param {PositiveNumber} sigmay - known standard deviation of `y`
56-
* @param {Float64Array} x - input array
55+
* @param {Float64Array} x - first input array
5756
* @param {integer} strideX - stride length for `x`
5857
* @param {NonNegativeInteger} offsetX - starting index for `x`
59-
* @param {Float64Array} y - input array
58+
* @param {PositiveNumber} sigmay - known standard deviation of `y`
59+
* @param {Float64Array} y - second input array
6060
* @param {integer} strideY - stride length for `y`
6161
* @param {NonNegativeInteger} offsetY - starting index for `y`
6262
* @param {Object} out - output results object
@@ -70,13 +70,13 @@ var WORKSPACE = new Float64Array( 2 );
7070
* var y = new Float64Array( [ 3.0, 3.0, 5.0, 7.0, 7.0 ] );
7171
*
7272
* var results = new Results();
73-
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, 2.0, x, 1, 0, y, 1, 0, results );
73+
* var out = dztest2( x.length, y.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, 2.0, y, 1, 0, results );
7474
* // returns {...}
7575
*
7676
* var bool = ( out === results );
7777
* // returns true
7878
*/
79-
function dztest2( NX, NY, alternative, alpha, diff, sigmax, sigmay, x, strideX, offsetX, y, strideY, offsetY, out ) { // eslint-disable-line max-len, max-params
79+
function dztest2( NX, NY, alternative, alpha, diff, sigmax, x, strideX, offsetX, sigmay, y, strideY, offsetY, out ) { // eslint-disable-line max-len, max-params
8080
var pValue;
8181
var stderr;
8282
var xmean;

0 commit comments

Comments
 (0)