repl.txt (1770B)
1 2 {{alias}}( x, k, λ ) 3 Evaluates the cumulative distribution function (CDF) for an Erlang 4 distribution with shape parameter `k` and rate parameter `λ` at a value 5 `x`. 6 7 If provided `NaN` as any argument, the function returns `NaN`. 8 9 If not provided a nonnegative integer for `k`, the function returns `NaN`. 10 11 If provided a non-positive value for `λ`, the function returns `NaN`. 12 13 Parameters 14 ---------- 15 x: number 16 Input value. 17 18 k: number 19 Shape parameter. 20 21 λ: number 22 Rate parameter. 23 24 Returns 25 ------- 26 out: number 27 Evaluated CDF. 28 29 Examples 30 -------- 31 > var y = {{alias}}( 2.0, 1, 1.0 ) 32 ~0.865 33 > y = {{alias}}( 2.0, 3, 1.0 ) 34 ~0.323 35 > y = {{alias}}( 2.0, 2.5, 1.0 ) 36 NaN 37 > y = {{alias}}( -1.0, 2, 2.0 ) 38 0.0 39 > y = {{alias}}( {{alias:@stdlib/constants/float64/pinf}}, 4, 2.0 ) 40 1.0 41 > y = {{alias}}( {{alias:@stdlib/constants/float64/ninf}}, 4, 2.0 ) 42 0.0 43 > y = {{alias}}( NaN, 0, 1.0 ) 44 NaN 45 > y = {{alias}}( 0.0, NaN, 1.0 ) 46 NaN 47 > y = {{alias}}( 0.0, 0, NaN ) 48 NaN 49 > y = {{alias}}( 2.0, -1, 1.0 ) 50 NaN 51 > y = {{alias}}( 2.0, 1, -1.0 ) 52 NaN 53 54 55 {{alias}}.factory( k, λ ) 56 Returns a function for evaluating the cumulative distribution function (CDF) 57 of an Erlang distribution with shape parameter `k` and rate parameter `λ`. 58 59 Parameters 60 ---------- 61 k: number 62 Shape parameter. 63 64 λ: number 65 Rate parameter. 66 67 Returns 68 ------- 69 cdf: Function 70 Cumulative distribution function (CDF). 71 72 Examples 73 -------- 74 > var mycdf = {{alias}}.factory( 2, 0.5 ); 75 > var y = mycdf( 6.0 ) 76 ~0.801 77 > y = mycdf( 2.0 ) 78 ~0.264 79 80 See Also 81 -------- 82