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

Mode

Gamma distribution mode.

The mode for a gamma random variable is

when shape α >= 1 and rate β > 0. For other parameter values, the mode is not defined.

Usage

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

mode( alpha, beta )

Returns the mode of a gamma distribution with parameters alpha (shape parameter) and beta (rate parameter).

var v = mode( 1.0, 1.0 );
// returns 0.0

v = mode( 4.0, 12.0 );
// returns 0.25

v = mode( 8.0, 2.0 );
// returns 3.5

If provided NaN as any argument, the function returns NaN.

var v = mode( NaN, 2.0 );
// returns NaN

v = mode( 2.0, NaN );
// returns NaN

If provided alpha <= 0, the function returns NaN.

var v = mode( 0.0, 1.0 );
// returns NaN

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

If provided beta <= 0, the function returns NaN.

var v = mode( 1.0, 0.0 );
// returns NaN

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

Examples

var randu = require( '@stdlib/random/base/randu' );
var EPS = require( '@stdlib/constants/float64/eps' );
var mode = require( '@stdlib/stats/base/dists/gamma/mode' );

var alpha;
var beta;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    alpha = ( randu()*10.0 ) + EPS;
    beta = ( randu()*10.0 ) + EPS;
    v = mode( alpha, beta );
    console.log( 'α: %d, β: %d, mode(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}