repl.txt (1467B)
1 2 {{alias}}( x, sigma ) 3 Evaluates the cumulative distribution function (CDF) for a Rayleigh 4 distribution with scale parameter `sigma` at a value `x`. 5 6 If provided `NaN` as any argument, the function returns `NaN`. 7 8 If provided a negative value for `sigma`, the function returns `NaN`. 9 10 Parameters 11 ---------- 12 x: number 13 Input value. 14 15 sigma: number 16 Scale parameter. 17 18 Returns 19 ------- 20 out: number 21 Evaluated CDF. 22 23 Examples 24 -------- 25 > var y = {{alias}}( 2.0, 3.0 ) 26 ~0.199 27 > y = {{alias}}( 1.0, 2.0 ) 28 ~0.118 29 > y = {{alias}}( -1.0, 4.0 ) 30 0.0 31 > y = {{alias}}( NaN, 1.0 ) 32 NaN 33 > y = {{alias}}( 0.0, NaN ) 34 NaN 35 36 // Negative scale parameter: 37 > y = {{alias}}( 2.0, -1.0 ) 38 NaN 39 40 // Degenerate distribution when `sigma = 0.0`: 41 > y = {{alias}}( -2.0, 0.0 ) 42 0.0 43 > y = {{alias}}( 0.0, 0.0 ) 44 1.0 45 > y = {{alias}}( 2.0, 0.0 ) 46 1.0 47 48 49 {{alias}}.factory( sigma ) 50 Returns a function for evaluating the cumulative distribution function (CDF) 51 of a Rayleigh distribution with scale parameter `sigma`. 52 53 Parameters 54 ---------- 55 sigma: number 56 Scale parameter. 57 58 Returns 59 ------- 60 cdf: Function 61 Cumulative distribution function (CDF). 62 63 Examples 64 -------- 65 > var myCDF = {{alias}}.factory( 0.5 ); 66 > var y = myCDF( 1.0 ) 67 ~0.865 68 > y = myCDF( 0.5 ) 69 ~0.393 70 71 See Also 72 -------- 73