-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
178 lines (158 loc) · 4.33 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/// <reference types="@stdlib/types"/>
import { NumericArray } from '@stdlib/types/array';
/**
* Interface defining function options.
*/
interface Options {
/**
* Significance level (default: 0.05).
*/
alpha?: number;
/**
* Array of group indicators.
*/
groups?: Array<any>;
}
/**
* Test result.
*/
interface Results {
/**
* Used significance level.
*/
alpha: number;
/**
* Test decision.
*/
rejected: boolean;
/**
* p-value of the test.
*/
pValue: number;
/**
* Value of test statistic.
*/
statistic: number;
/**
* Name of test.
*/
method: string;
/**
* Degrees of freedom.
*/
df: number;
/**
* Function to print formatted output.
*/
print: Function;
}
/**
* Computes the Fligner-Killeen test for equal variances.
*
* @param arr0 - numeric array
* @param options - function options
* @param options.alpha - significance level (default: 0.05)
* @param options.groups - array of group indicators
* @throws must provide at least two array-like arguments if `groups` is not set
* @throws must provide valid options
* @returns test results
*
* @example
* var arr = [
* 2.9, 3.0, 2.5, 2.6, 3.2,
* 3.8, 2.7, 4.0, 2.4,
* 2.8, 3.4, 3.7, 2.2, 2.0
* ];
* var groups = [
* 'a', 'a', 'a', 'a', 'a',
* 'b', 'b', 'b', 'b',
* 'c', 'c', 'c', 'c', 'c'
* ];
* varout = flignerTest( arr, {
* 'groups': groups
* });
* // returns {...}
*/
declare function flignerTest( arr0: NumericArray, options?: Options ): Results;
/**
* Computes the Fligner-Killeen test for equal variances.
*
* @param arr0 - first numeric array
* @param arr1 - second numeric array
* @param options - function options
* @param options.alpha - significance level (default: 0.05)
* @throws must provide valid options
* @returns test results
*
* @example
* // Data from Hollander & Wolfe (1973), p. 116:
* var x = [ 2.9, 3.0, 2.5, 2.6, 3.2 ];
* var y = [ 3.8, 2.7, 4.0, 2.4 ];
*
* var out = flignerTest( x, y );
* // returns {...}
*/
declare function flignerTest( arr0: NumericArray, arr1: NumericArray, options?: Options ): Results; // tslint-disable-line max-line-length
/**
* Computes the Fligner-Killeen test for equal variances.
*
* @param arr0 - first numeric array
* @param arr1 - second numeric array
* @param arr2 - third numeric array
* @param options - function options
* @param options.alpha - significance level (default: 0.05)
* @throws must provide valid options
* @returns test results
*
* @example
* // Data from Hollander & Wolfe (1973), p. 116:
* var x = [ 2.9, 3.0, 2.5, 2.6, 3.2 ];
* var y = [ 3.8, 2.7, 4.0, 2.4 ];
* var z = [ 2.8, 3.4, 3.7, 2.2, 2.0 ];
*
* var out = flignerTest( x, y, z );
* // returns {...}
*/
declare function flignerTest( arr0: NumericArray, arr1: NumericArray, arr2: NumericArray, options?: Options ): Results; // tslint-disable-line max-line-length
/**
* Computes the Fligner-Killeen test for equal variances.
*
* @param arr0 - first numeric array
* @param arr1 - second numeric array
* @param arr2 - third numeric array
* @param arr3 - fourth numeric array
* @param options - function options
* @param options.alpha - significance level (default: 0.05)
* @throws must provide valid options
* @returns test results
*/
declare function flignerTest( arr0: NumericArray, arr1: NumericArray, arr2: NumericArray, arr3: NumericArray, options?: Options ): Results; // tslint-disable-line max-line-length
/**
* Computes the Fligner-Killeen test for equal variances.
*
* @param arr0 - first numeric array
* @param args - subsequent numeric arrays and an optional options object
* @throws must provide valid options
* @returns test results
*/
declare function flignerTest( arr0: NumericArray, ...args: Array<NumericArray | Options> ): Results; // tslint-disable-line max-line-length
// EXPORTS //
export = flignerTest;