@stdlib/stats
Version:
Standard library statistical functions.
34 lines (24 loc) • 533 B
Plain Text
{{alias}}( α, β )
Returns the mode of a gamma distribution.
If `α <= 0` or `β <= 0`, the function returns `NaN`.
If `α` or `β` is `NaN`, the function returns `NaN`.
Parameters
----------
α: number
Shape parameter.
β: number
Rate parameter.
Returns
-------
out: number
Mode.
Examples
--------
> var v = {{alias}}( 1.0, 1.0 )
0.0
> v = {{alias}}( 4.0, 12.0 )
0.25
> v = {{alias}}( 8.0, 2.0 )
3.5
See Also
--------