@stdlib/stats
Version:
Standard library statistical functions.
39 lines (29 loc) • 668 B
Plain Text
{{alias}}( μ, σ )
Returns the mode of a lognormal distribution with location `μ` and scale
`σ`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `σ <= 0`, the function returns `NaN`.
Parameters
----------
μ: number
Location parameter.
σ: number
Scale parameter.
Returns
-------
out: number
Mode.
Examples
--------
> var y = {{alias}}( 0.0, 1.0 )
~0.368
> y = {{alias}}( 5.0, 2.0 )
~2.718
> y = {{alias}}( NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN )
NaN
> y = {{alias}}( 0.0, 0.0 )
NaN
See Also
--------