Mode

Laplace distribution mode.

The mode for a Laplace random variable with location parameter mu and scale parameter b > 0 is

m o d e left-parenthesis upper X right-parenthesis equals mu

Usage

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

mode( mu, b )

Returns the mode for a Laplace distribution with location parameter mu and scale parameter b.

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 b <= 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/laplace/mode' );

var mu;
var b;
var y;
var i;

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