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

Mode

Arcsine distribution mode.

The mode for an arcsine random variable with with minimum support a and maximum support b is

Usage

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

mode( a, b )

Returns the mode of an arcsine distribution with parameters a (minimum support) and b (maximum support).

var v = mode( 0.0, 1.0 );
// returns 0.0

v = mode( 4.0, 12.0 );
// returns 4.0

v = mode( 2.0, 8.0 );
// returns 2.0

If provided NaN as any argument, the function returns NaN.

var v = mode( NaN, 2.0 );
// returns NaN

v = mode( 2.0, NaN );
// returns NaN

If provided a >= b, the function returns NaN.

var y = mode( 3.0, 2.0 );
// returns NaN

y = mode( 3.0, 3.0 );
// returns NaN

Examples

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

var a;
var b;
var v;
var i;

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