repl.txt (1581B)
1 2 {{alias}}( p, x0, Ɣ ) 3 Evaluates the quantile function for a Cauchy distribution with location 4 parameter `x0` and scale parameter `Ɣ` at a probability `p`. 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`, the function returns `NaN`. 11 12 Parameters 13 ---------- 14 p: number 15 Input probability. 16 17 x0: number 18 Location parameter. 19 20 Ɣ: number 21 Scale parameter. 22 23 Returns 24 ------- 25 out: number 26 Evaluated quantile function. 27 28 Examples 29 -------- 30 > var y = {{alias}}( 0.3, 2.0, 2.0 ) 31 ~0.547 32 > y = {{alias}}( 0.8, 10, 2.0 ) 33 ~12.753 34 > y = {{alias}}( 0.1, 10.0, 2.0 ) 35 ~3.845 36 37 > y = {{alias}}( 1.1, 0.0, 1.0 ) 38 NaN 39 > y = {{alias}}( -0.2, 0.0, 1.0 ) 40 NaN 41 42 > y = {{alias}}( NaN, 0.0, 1.0 ) 43 NaN 44 > y = {{alias}}( 0.0, NaN, 1.0 ) 45 NaN 46 > y = {{alias}}( 0.0, 0.0, NaN ) 47 NaN 48 49 // Negative scale parameter: 50 > y = {{alias}}( 0.5, 0.0, -1.0 ) 51 NaN 52 53 54 {{alias}}.factory( x0, Ɣ ) 55 Returns a function for evaluating the quantile function of a Cauchy 56 distribution with location parameter `x0` and scale parameter `Ɣ`. 57 58 Parameters 59 ---------- 60 x0: number 61 Location parameter. 62 63 Ɣ: number 64 Scale parameter. 65 66 Returns 67 ------- 68 quantile: Function 69 Quantile function. 70 71 Examples 72 -------- 73 > var myQuantile = {{alias}}.factory( 10.0, 2.0 ); 74 > var y = myQuantile( 0.5 ) 75 10.0 76 77 See Also 78 -------- 79