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

Mode

Triangular distribution mode.

The mode for a triangular random variable with lower limit a, upper limit b, and mode c is

Usage

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

mode( a, b, c )

Returns the mode of a triangular distribution with parameters a (minimum support), b (maximum support), and c (mode).

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

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

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

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

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

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

v = mode( 0.0, 4.0, NaN );
// returns NaN

If provided parameters not satisfying a <= c <= b, the function returns NaN.

var y = mode( 1.0, 0.0, 1.5 );
// returns NaN

y = mode( 0.0, 1.0, -1.0 );
// returns NaN

y = mode( 0.0, -1.0, 0.5 );
// returns NaN

Examples

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

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

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