@stdlib/stats
Version:
Standard library statistical functions.
78 lines (59 loc) • 1.62 kB
Plain Text
{{alias}}( x, μ, s )
Evaluates the logarithm of 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 logPDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.0, 3.0 )
~-2.485
> y = {{alias}}( -1.0, 2.0, 4.0 )
~-3.307
> 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
// Degenerate distribution at `s = 0.0`:
> y = {{alias}}( 2.0, 8.0, 0.0 )
-Infinity
> y = {{alias}}( 8.0, 8.0, 0.0 )
Infinity
{{alias}}.factory( μ, s )
Returns a function for evaluating the logarithm of 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
-------
logpdf: Function
Logarithm of probability density function (PDF).
Examples
--------
> var mylogpdf = {{alias}}.factory( 10.0, 2.0 );
> var y = mylogpdf( 10.0 )
~-0.693
See Also
--------