time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/poisson/mode

Mode

Poisson distribution mode.

The mode for a Poisson random variable is

where λ is the mean parameter.

Usage

var mode = require( '@stdlib/stats/base/dists/poisson/mode' );

mode( lambda )

Returns the mode of a Poisson distribution with mean parameter lambda.

var v = mode( 9.0 );
// returns 9

v = mode( 0.5 );
// returns 0

If provided lambda < 0, the function returns NaN.

var v = mode( -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var mode = require( '@stdlib/stats/base/dists/poisson/mode' );

var lambda;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    lambda = randu() * 20.0;
    v = mode( lambda );
    console.log( 'λ: %d, mode(X;λ): %d', lambda.toFixed( 4 ), v.toFixed( 4 ) );
}