time-to-botec/js/node_modules/@stdlib/stats/base/dists/frechet/mode

Mode

Fréchet distribution mode.

The mode for a Fréchet random variable shape α > 0, scale s > 0, and location parameter m is

Usage

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

mode( alpha, s, m )

Returns the mode for a Fréchet distribution with shape alpha > 0, scale s > 0, and location parameter m.

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

y = mode( 1.0, 2.0, -3.0 );
// returns -2.0

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

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

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

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

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

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

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

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

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

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

y = mode( 1.0, -1.0, 2.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/frechet/mode' );

var alpha;
var m;
var s;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    alpha = ( randu()*20.0 ) + EPS;
    s = ( randu()*20.0 ) + EPS;
    m = ( randu()*20.0 ) - 40.0;
    y = mode( alpha, s, m );
    console.log( 'α: %d, s: %d, m: %d, mode(X;α,s,m): %d', alpha.toFixed( 4 ), s.toFixed( 4 ), m.toFixed( 4 ), y.toFixed( 4 ) );
}