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

Mode

Gumbel distribution mode.

The mode for a Gumbel random variable with location μ and scale β is

Usage

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

mode( mu, beta )

Returns the mode for a Gumbel distribution with location parameter mu and scale parameter beta.

var y = mode( 2.0, 1.0 );
// returns 2.0

y = mode( 0.0, 1.0 );
// returns 0.0

y = mode( -1.0, 4.0 );
// returns -1.0

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

var y = mode( NaN, 1.0 );
// returns NaN

y = mode( 0.0, NaN );
// returns NaN

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

var y = mode( 0.0, 0.0 );
// returns NaN

y = mode( 0.0, -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var mode = require( '@stdlib/stats/base/dists/gumbel/mode' );

var beta;
var mu;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    mu = ( randu()*10.0 ) - 5.0;
    beta = randu() * 20.0;
    y = mode( mu, beta );
    console.log( 'µ: %d, β: %d, mode(X;µ,β): %d', mu.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}