repl.txt (1501B)
1 2 {{alias}}( x, μ, s ) 3 Evaluates the probability density function (PDF) for a raised cosine 4 distribution with location parameter `μ` and scale parameter `s` at a value 5 `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 PDF. 26 27 Examples 28 -------- 29 > var y = {{alias}}( 2.0, 0.0, 3.0 ) 30 ~0.083 31 > y = {{alias}}( 2.4, 4.0, 2.0 ) 32 ~0.048 33 > y = {{alias}}( NaN, 0.0, 1.0 ) 34 NaN 35 > y = {{alias}}( 0.0, NaN, 1.0 ) 36 NaN 37 > y = {{alias}}( 0.0, 0.0, NaN ) 38 NaN 39 // Negative scale parameter: 40 > y = {{alias}}( 2.0, 0.0, -1.0 ) 41 NaN 42 > y = {{alias}}( 2.0, 8.0, 0.0 ) 43 0.0 44 > y = {{alias}}( 8.0, 8.0, 0.0 ) 45 Infinity 46 47 48 {{alias}}.factory( μ, s ) 49 Returns a function for evaluating the probability density function (PDF) of 50 a raised cosine distribution with location parameter `μ` and scale parameter 51 `s`. 52 53 Parameters 54 ---------- 55 μ: number 56 Location parameter. 57 58 s: number 59 Scale parameter. 60 61 Returns 62 ------- 63 pdf: Function 64 Probability density function (PDF). 65 66 Examples 67 -------- 68 > var myPDF = {{alias}}.factory( 0.0, 3.0 ); 69 > var y = myPDF( 2.0 ) 70 ~0.083 71 72 See Also 73 -------- 74