Mode

Student's t distribution mode.

The mode for a Student's t random variable with degrees of freedom ν is

Usage

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

mode( v )

Returns the mode of a Student's t distribution with degrees of freedom v.

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

y = mode( 1.5 );
// returns 0.0

If provided v < 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/t/mode' );

var v;
var y;
var i;

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

C APIs

Usage

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

stdlib_base_dists_t_mode( v )

Returns the mode of a Student's t distribution with degrees of freedom v.

double out = stdlib_base_dists_t_mode( 5.0 );
// returns 0.0

The function accepts the following arguments:

v: [in] double degrees of freedom.

double stdlib_base_dists_t_mode( const double v );

Examples

#include "stdlib/stats/base/dists/t/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 v;
    double y;
    int i;
    
    for ( i = 0; i < 25; i++ ) {
        v = random_uniform( 0.0, 100.0 );
        y = stdlib_base_dists_t_mode( v );
        printf( "v: %lf, mode: %lf\n", v, y );
    }
}