Mode

Degenerate distribution mode.

The mode for a degenerate random variable is

where μ is the constant value of the distribution.

Usage

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

mode( mu )

Returns the mode of a degenerate distribution with constant value mu.

var v = mode( 10.0 );
// returns 10.0

v = mode( -0.5 );
// returns -0.5

Examples

var randu = require( '@stdlib/random/base/randu' );
var mode = require( '@stdlib/stats/base/dists/degenerate/mode' );

var mu;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    mu = randu();
    v = mode( mu );
    console.log( 'µ: %d, mode(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}

C APIs

Usage

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

stdlib_base_dists_degenerate_mode( mu )

Returns the mode of a degenerate distribution with constant value mu.

double out = stdlib_base_dists_degenerate_mode( 0.1 );
// returns 0.1

The function accepts the following arguments:

mu: [in] double constant value of the distribution.

double stdlib_base_dists_degenerate_mode( const double mu );

Examples

#include "stdlib/stats/base/dists/degenerate/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 mu;
    double m;
    int i;

    for ( i = 0; i < 10; i++ ) {
        mu = random_uniform( 0.0, 20.0 );
        m = stdlib_base_dists_degenerate_mode( mu );
        printf( "µ: %lf, mode(X;µ): %lf\n", mu, m );
    }
}