time-to-botec/js/node_modules/@stdlib/stats/base/dists/poisson/pmf/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

72 lines
1.3 KiB
Plaintext

{{alias}}( x, λ )
Evaluates the probability mass function (PMF) for a Poisson
distribution with mean parameter `λ` at a value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided a negative value for `λ`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
λ: number
Mean parameter.
Returns
-------
out: number
Evaluated PMF.
Examples
--------
> var y = {{alias}}( 4.0, 3.0 )
~0.168
> y = {{alias}}( 1.0, 3.0 )
~0.149
> y = {{alias}}( -1.0, 2.0 )
0.0
> y = {{alias}}( 0.0, NaN )
NaN
> y = {{alias}}( NaN, 0.5 )
NaN
// Negative mean parameter:
> y = {{alias}}( 2.0, -0.5 )
NaN
// Degenerate distribution at `λ = 0`:
> y = {{alias}}( 2.0, 0.0 )
0.0
> y = {{alias}}( 0.0, 0.0 )
1.0
{{alias}}.factory( λ )
Returns a function for evaluating the probability mass function (PMF)
of a Poisson distribution with mean parameter `λ`.
Parameters
----------
λ: number
Mean parameter.
Returns
-------
pmf: Function
Probability mass function (PMF).
Examples
--------
> var mypmf = {{alias}}.factory( 1.0 );
> var y = mypmf( 3.0 )
~0.061
> y = mypmf( 1.0 )
~0.368
See Also
--------