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