repl.txt (830B)
1 2 {{alias}}( α, s, m ) 3 Returns the mode of a Fréchet distribution with shape parameter `α`, scale 4 parameter `s`, and location `m`. 5 6 If provided `NaN` as any argument, the function returns `NaN`. 7 8 If provided `α <= 0` or `s <= 0`, the function returns `NaN`. 9 10 Parameters 11 ---------- 12 α: number 13 Shape parameter. 14 15 s: number 16 Scale parameter. 17 18 m: number 19 Location parameter. 20 21 Returns 22 ------- 23 out: number 24 Mode. 25 26 Examples 27 -------- 28 > var y = {{alias}}( 4.0, 2.0, 1.0 ) 29 ~2.891 30 > var y = {{alias}}( 4.0, 2.0, -3.0 ) 31 ~-1.109 32 > y = {{alias}}( 0.5, 2.0, 1.0 ) 33 ~1.222 34 > y = {{alias}}( NaN, 1.0, 0.0 ) 35 NaN 36 > y = {{alias}}( 1.0, NaN, 0.0 ) 37 NaN 38 > y = {{alias}}( 1.0, 1.0, NaN ) 39 NaN 40 41 See Also 42 -------- 43