@stdlib/stats
Version:
Standard library statistical functions.
84 lines (64 loc) • 1.75 kB
Plain Text
{{alias}}( x, α, β )
Evaluates the logarithm of the probability density function (PDF) for a
gamma distribution with shape parameter `α` and rate parameter `β` at a
value `x`.
If `α < 0` or `β <= 0`, the function returns `NaN`.
If provided `NaN` as any argument, the function returns `NaN`.
Parameters
----------
x: number
Input value.
α: number
Shape parameter.
β: number
Rate parameter.
Returns
-------
out: number
Evaluated logPDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.5, 1.0 )
~-2.919
> y = {{alias}}( 0.1, 1.0, 1.0 )
~-0.1
> y = {{alias}}( -1.0, 4.0, 2.0 )
-Infinity
> y = {{alias}}( NaN, 0.6, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, 1.0, NaN )
NaN
// Negative shape parameter:
> y = {{alias}}( 2.0, -1.0, 1.0 )
NaN
// Non-positive rate parameter:
> y = {{alias}}( 2.0, 1.0, -1.0 )
NaN
// Degenerate distribution centered at `0.0` when `α = 0.0`:
> y = {{alias}}( 2.0, 0.0, 2.0 )
-Infinity
> y = {{alias}}( 0.0, 0.0, 2.0 )
Infinity
{{alias}}.factory( α, β )
Returns a function for evaluating the logarithm of the probability density
function (PDF) of a gamma distribution with shape parameter `α` and rate
parameter `β`.
Parameters
----------
α: number
Shape parameter.
β: number
Rate parameter.
Returns
-------
logpdf: Function
Logarithm of probability density function (PDF).
Examples
--------
> var mylogPDF = {{alias}}.factory( 6.0, 7.0 );
> var y = mylogPDF( 2.0 )
~-3.646
See Also
--------