@stdlib/stats
Version:
Standard library statistical functions.
75 lines (58 loc) • 1.5 kB
Plain Text
{{alias}}( x, μ, s )
Evaluates the probability density function (PDF) for a raised cosine
distribution with location parameter `μ` and scale parameter `s` at a value
`x`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `s < 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
μ: number
Location parameter.
s: number
Scale parameter.
Returns
-------
out: number
Evaluated PDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.0, 3.0 )
~0.083
> y = {{alias}}( 2.4, 4.0, 2.0 )
~0.048
> y = {{alias}}( NaN, 0.0, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, 0.0, NaN )
NaN
// Negative scale parameter:
> y = {{alias}}( 2.0, 0.0, -1.0 )
NaN
> y = {{alias}}( 2.0, 8.0, 0.0 )
0.0
> y = {{alias}}( 8.0, 8.0, 0.0 )
Infinity
{{alias}}.factory( μ, s )
Returns a function for evaluating the probability density function (PDF) of
a raised cosine distribution with location parameter `μ` and scale parameter
`s`.
Parameters
----------
μ: number
Location parameter.
s: number
Scale parameter.
Returns
-------
pdf: Function
Probability density function (PDF).
Examples
--------
> var myPDF = {{alias}}.factory( 0.0, 3.0 );
> var y = myPDF( 2.0 )
~0.083
See Also
--------