-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
75 lines (70 loc) · 1.72 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
/*
* @license Apache-2.0
*
* Copyright (c) 2019 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
/**
* Returns the standard deviation of a hypergeometric distribution.
*
* ## Notes
*
* - If provided a population size `N`, subpopulation size `K` or draws `n` which is not a nonnegative integer, the function returns `NaN`.
* - If the number of draws `n` or subpopulation size `K` exceed population size `N`, the function returns `NaN`.
*
* @param N - population size
* @param K - subpopulation size
* @param n - number of draws
* @returns standard deviation
*
* @example
* var v = stdev( 16, 11, 4 );
* // returns ~0.829
*
* @example
* var v = stdev( 2, 1, 1 );
* // returns 0.5
*
* @example
* var v = stdev( 10, 5, 12 );
* // returns NaN
*
* @example
* var v = stdev( 10.3, 10, 4 );
* // returns NaN
*
* @example
* var v = stdev( 10, 5.5, 4 );
* // returns NaN
*
* @example
* var v = stdev( 10, 5, 4.5 );
* // returns NaN
*
* @example
* var v = stdev( NaN, 10, 4 );
* // returns NaN
*
* @example
* var v = stdev( 20, NaN, 4 );
* // returns NaN
*
* @example
* var v = stdev( 20, 10, NaN );
* // returns NaN
*/
declare function stdev( N: number, K: number, n: number ): number;
// EXPORTS //
export = stdev;