Mode

Lognormal distribution mode.

The mode for a lognormal random variable is

m o d e left-parenthesis upper X right-parenthesis equals exp left-parenthesis mu minus sigma squared right-parenthesis

where μ is the location parameter and σ > 0 is the scale parameter. According to the definition, the natural logarithm of a random variable from a lognormal distribution follows a normal distribution.

Usage

var mode = require( '@stdlib/math/base/dists/lognormal/mode' );

mode( mu, sigma )

Returns the mode for a lognormal distribution with location mu and scale sigma.

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

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

y = mode( -1.0, 4.0 );
// returns 0.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 sigma <= 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/math/base/dists/lognormal/mode' );

var sigma;
var mu;
var y;
var i;

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