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

Mode

Rayleigh distribution mode.

The mode for a Rayleigh random variable is

where σ > 0 is the scale parameter.

Usage

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

mode( sigma )

Returns the mode of a Rayleigh distribution with scale parameter sigma.

var y = mode( 9.0 );
// returns 9.0

y = mode( 1.5 );
// returns 1.5

If provided sigma < 0, the function returns NaN.

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

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var mode = require( '@stdlib/stats/base/dists/rayleigh/mode' );

var sigma;
var y;
var i;

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