@stdlib/stats-base-dists-weibull-mode NPM

Mode

Weibull distribution mode.

The mode for a Weibull random variable is

where λ > 0 is the shape parameter and k > 0 is the scale parameter.

Installation

npm install @stdlib/stats-base-dists-weibull-mode

Usage

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

mode( k, lambda )

Returns the mode of a Weibull distribution with parameters k (shape parameter) and lambda (scale parameter).

var v = mode( 4.0, 12.0 );
// returns ~11.167

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

If provided 0 < k <= 1, the function returns 0.0.

var v = mode( 1.0, 1.0 );
// returns 0.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 k <= 0, the function returns NaN.

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

v = mode( -1.0, 1.0 );
// returns NaN

If provided lambda <= 0, the function returns NaN.

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

v = mode( 1.0, -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var EPS = require( '@stdlib/constants-float64-eps' );
var mode = require( '@stdlib/stats-base-dists-weibull-mode' );

var lambda;
var k;
var v;
var i;

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

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.