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 ) );
}

C APIs

Usage

#include "stdlib/stats/base/dists/rayleigh/mode.h"

stdlib_base_dists_rayleigh_mode( sigma )

Returns the mode of a Rayleigh distribution.

double out = stdlib_base_dists_rayleigh_mode( 9.0 );
// returns 9.0

The function accepts the following arguments:

sigma: [in] double scale parameter.

double stdlib_base_dists_rayleigh_mode( const double sigma );

Examples

#include "stdlib/stats/base/dists/rayleigh/mode.h"
#include <stdlib.h>
#include <stdio.h>

static double random_uniform( const double min, const double max ) {
    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
    return min + ( v*(max-min) );
}

int main( void ) {
    double sigma;
    double y;
    int i;

    for ( i = 0; i < 25; i++ ) {
        sigma = random_uniform( 0.0, 20.0 );
        y = stdlib_base_dists_rayleigh_mode( sigma );
        printf( "σ: %lf, mode(X;σ): %lf\n", sigma, y );
    }
}