# Mode

Erlang distribution mode.

The mode for an Erlang random variable is

where k is the shape parameter and λ is the rate parameter.

## Usage

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


#### mode( k, lambda )

Returns the mode of an Erlang distribution with parameters k (shape parameter) and lambda (rate parameter).

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

v = mode( 4, 12.0 );
// returns 0.25

v = mode( 8, 2.0 );
// returns 3.5


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 not provided a positive integer for k, the function returns NaN.

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

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


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

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

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


## Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var EPS = require( '@stdlib/constants/math/float64-eps' );
var mode = require( '@stdlib/math/base/dists/erlang/mode' );

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

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
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 ) );
}