repl.txt (1626B)
1 2 {{alias}}( x, μ, s ) 3 Evaluates the natural logarithm of the cumulative distribution function 4 (CDF) for a raised cosine distribution with location parameter `μ` and scale 5 parameter `s` at a value `x`. 6 7 If provided `NaN` as any argument, the function returns `NaN`. 8 9 If provided `s < 0`, the function returns `NaN`. 10 11 Parameters 12 ---------- 13 x: number 14 Input value. 15 16 μ: number 17 Location parameter. 18 19 s: number 20 Scale parameter. 21 22 Returns 23 ------- 24 out: number 25 Evaluated logCDF. 26 27 Examples 28 -------- 29 > var y = {{alias}}( 2.0, 0.0, 3.0 ) 30 ~-0.029 31 > y = {{alias}}( 9.0, 10.0, 3.0 ) 32 ~-1.632 33 34 > y = {{alias}}( 2.0, 0.0, NaN ) 35 NaN 36 > y = {{alias}}( 2.0, NaN, 1.0 ) 37 NaN 38 > y = {{alias}}( NaN, 0.0, 1.0 ) 39 NaN 40 41 // Degenerate distribution centered at `μ` when `s = 0.0`: 42 > y = {{alias}}( 2.0, 8.0, 0.0 ) 43 -Infinity 44 > y = {{alias}}( 8.0, 8.0, 0.0 ) 45 0.0 46 > y = {{alias}}( 10.0, 8.0, 0.0 ) 47 0.0 48 49 50 {{alias}}.factory( μ, s ) 51 Returns a function for evaluating the natural logarithm of the cumulative 52 distribution function (CDF) of a raised cosine distribution with location 53 parameter `μ` and scale parameter `s`. 54 55 Parameters 56 ---------- 57 μ: number 58 Location parameter. 59 60 s: number 61 Scale parameter. 62 63 Returns 64 ------- 65 logcdf: Function 66 Logarithm of cumulative distribution function (CDF). 67 68 Examples 69 -------- 70 > var mylogcdf = {{alias}}.factory( 3.0, 1.5 ); 71 > var y = mylogcdf( 1.9 ) 72 ~-4.2 73 74 See Also 75 -------- 76