@stdlib/stats
Version:
Standard library statistical functions.
36 lines (25 loc) • 630 B
Plain Text
{{alias}}( k, λ )
Returns the mode of an Erlang distribution.
If provided `NaN` as any argument, the function returns `NaN`.
If not provided a positive integer for `k`, the function returns `NaN`.
If provided a non-positive value for `λ`, the function returns `NaN`.
Parameters
----------
k: integer
Shape parameter.
λ: number
Rate parameter.
Returns
-------
out: number
Mode.
Examples
--------
> var v = {{alias}}( 1, 1.0 )
0.0
> v = {{alias}}( 4, 12.0 )
0.25
> v = {{alias}}( 8, 2.0 )
3.5
See Also
--------