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

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