Mode

Chi-squared distribution mode.

The mode for a chi-squared random variable is

m o d e left-parenthesis upper X right-parenthesis equals max left-parenthesis k minus 2 comma 0 right-parenthesis

where k >= 0 is the degrees of freedom.

Usage

var mode = require( '@stdlib/math/base/dists/chisquare/mode' );

mode( k )

Returns the mode of a chi-squared distribution with degrees of freedom k.

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

v = mode( 0.5 );
// returns 0.0

If provided k < 0, the function returns NaN.

var v = 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/math/base/dists/chisquare/mode' );

var k;
var v;
var i;

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