@stdlib/stats
Version:
Standard library statistical functions.
65 lines (50 loc) • 1.32 kB
Plain Text
{{alias}}( x, p )
Evaluates the logarithm of the probability mass function (PMF) for a
geometric distribution with success probability `p` at a value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If `p < 0` or `p > 1`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
p: number
Success probability.
Returns
-------
out: number
Evaluated logPMF.
Examples
--------
> var y = {{alias}}( 4.0, 0.3 )
~-2.631
> y = {{alias}}( 2.0, 0.7 )
~-2.765
> y = {{alias}}( -1.0, 0.5 )
-Infinity
> y = {{alias}}( 0.0, NaN )
NaN
> y = {{alias}}( NaN, 0.5 )
NaN
// Invalid success probability:
> y = {{alias}}( 2.0, 1.5 )
NaN
{{alias}}.factory( p )
Returns a function for evaluating the logarithm of the probability mass
function (PMF) of a geometric distribution with success probability `p`.
Parameters
----------
p: number
Success probability.
Returns
-------
logpmf: Function
Logarithm of probability mass function (PMF).
Examples
--------
> var mylogpmf = {{alias}}.factory( 0.5 );
> var y = mylogpmf( 3.0 )
~-2.773
> y = mylogpmf( 1.0 )
~-1.386
See Also
--------