repl.txt (1382B)
1 2 {{alias}}( p, sigma ) 3 Evaluates the quantile function for a Rayleigh distribution with scale 4 parameter `sigma` 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 a negative probability for `sigma`, the function returns `NaN`. 11 12 Parameters 13 ---------- 14 p: number 15 Input probability. 16 17 sigma: number 18 Scale parameter. 19 20 Returns 21 ------- 22 out: number 23 Evaluated quantile function. 24 25 Examples 26 -------- 27 > var y = {{alias}}( 0.8, 1.0 ) 28 ~1.794 29 > y = {{alias}}( 0.5, 4.0 ) 30 ~4.71 31 32 > y = {{alias}}( 1.1, 1.0 ) 33 NaN 34 > y = {{alias}}( -0.2, 1.0 ) 35 NaN 36 37 > y = {{alias}}( NaN, 1.0 ) 38 NaN 39 > y = {{alias}}( 0.0, NaN ) 40 NaN 41 42 // Negative scale parameter: 43 > y = {{alias}}( 0.5, -1.0 ) 44 NaN 45 46 47 {{alias}}.factory( sigma ) 48 Returns a function for evaluating the quantile function of a Rayleigh 49 distribution with scale parameter `sigma`. 50 51 Parameters 52 ---------- 53 sigma: number 54 Scale parameter. 55 56 Returns 57 ------- 58 quantile: Function 59 Quantile function. 60 61 Examples 62 -------- 63 > var myQuantile = {{alias}}.factory( 0.4 ); 64 > var y = myQuantile( 0.4 ) 65 ~0.404 66 > y = myQuantile( 1.0 ) 67 Infinity 68 69 See Also 70 -------- 71