repl.txt (1736B)
1 2 {{alias}}( p, α, s, m ) 3 Evaluates the quantile function for a Fréchet distribution with shape 4 parameter `α`, scale parameter `s`, and location `m`. 5 6 If `p < 0` or `p > 1`, the function returns `NaN`. 7 8 If provided `NaN` as any argument, the function returns `NaN`. 9 10 If provided `α <= 0` or `s <= 0`, the function returns `NaN`. 11 12 Parameters 13 ---------- 14 p: number 15 Input probability. 16 17 α: number 18 Shape parameter. 19 20 s: number 21 Scale parameter. 22 23 m: number 24 Location parameter. 25 26 Returns 27 ------- 28 out: number 29 Evaluated quantile function. 30 31 Examples 32 -------- 33 > var y = {{alias}}( 0.3, 10.0, 2.0, 3.0 ) 34 ~4.963 35 > y = {{alias}}( 0.2, 3.0, 3.0, 3.0 ) 36 ~5.56 37 > y = {{alias}}( 0.9, 1.0, 1.0, -3.0 ) 38 ~6.491 39 > y = {{alias}}( NaN, 1.0, 1.0, 0.0 ) 40 NaN 41 > y = {{alias}}( 0.0, NaN, 1.0, 0.0) 42 NaN 43 > y = {{alias}}( 0.0, 1.0, NaN, 0.0 ) 44 NaN 45 > y = {{alias}}( 0.0, 1.0, 1.0, NaN ) 46 NaN 47 > y = {{alias}}( 0.0, -1.0, 1.0, 0.0 ) 48 NaN 49 > y = {{alias}}( 0.0, 1.0, -1.0, 0.0 ) 50 NaN 51 52 53 {{alias}}.factory( α, s, m ) 54 Returns a function for evaluating the quantile function of a Fréchet 55 distribution with shape parameter `α`, scale parameter `s`, and location 56 `m`. 57 58 Parameters 59 ---------- 60 α: number 61 Shape parameter. 62 63 s: number 64 Scale parameter. 65 66 m: number 67 Location parameter. 68 69 Returns 70 ------- 71 quantile: Function 72 Quantile function. 73 74 Examples 75 -------- 76 > var myQuantile = {{alias}}.factory( 2.0, 2.0, 3.0 ); 77 > var y = myQuantile( 0.5 ) 78 ~5.402 79 > y = myQuantile( 0.2 ) 80 ~4.576 81 82 See Also 83 -------- 84