-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
70 lines (65 loc) · 1.47 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
/*
* @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 mode of an Erlang distribution.
*
* ## Notes
*
* - If not provided a positive integer for `k`, the function returns `NaN`.
* - If provided a non-positive value for `lambda`, the function returns `NaN`.
*
* @param k - shape parameter
* @param lambda - rate parameter
* @returns mode
*
* @example
* var v = mode( 1, 1.0 );
* // returns 0.0
*
* @example
* var v = mode( 4, 12.0 );
* // returns 0.25
*
* @example
* var v = mode( 8, 2.0 );
* // returns 3.5
*
* @example
* var v = mode( 1.5, 2.0 );
* // returns NaN
*
* @example
* var v = mode( 1, -0.1 );
* // returns NaN
*
* @example
* var v = mode( -0.1, 1.0 );
* // returns NaN
*
* @example
* var v = mode( 2, NaN );
* // returns NaN
*
* @example
* var v = mode( NaN, 2.0 );
* // returns NaN
*/
declare function mode( k: number, lambda: number ): number;
// EXPORTS //
export = mode;