@stdlib/stats
Version:
Standard library statistical functions.
81 lines (61 loc) • 1.63 kB
Plain Text
{{alias}}( p, μ, σ )
Evaluates the quantile function for a lognormal distribution with location
parameter `μ` and scale parameter `σ` at a probability `p`.
If `p < 0` or `p > 1`, the function returns `NaN`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `σ <= 0`, the function returns `NaN`.
Parameters
----------
p: number
Input probability.
μ: number
Location parameter.
σ: number
Scale parameter.
Returns
-------
out: number
Evaluated quantile function.
Examples
--------
> var y = {{alias}}( 0.8, 0.0, 1.0 )
~2.32
> y = {{alias}}( 0.5, 4.0, 2.0 )
~54.598
> y = {{alias}}( 1.1, 0.0, 1.0 )
NaN
> y = {{alias}}( -0.2, 0.0, 1.0 )
NaN
> y = {{alias}}( NaN, 0.0, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, 0.0, NaN )
NaN
// Non-positive scale parameter `σ`:
> y = {{alias}}( 0.5, 0.0, -1.0 )
NaN
> y = {{alias}}( 0.5, 0.0, 0.0 )
NaN
{{alias}}.factory( μ, σ )
Returns a function for evaluating the quantile function of a lognormal
distribution with location parameter `μ` and scale parameter `σ`.
Parameters
----------
μ: number
Location parameter.
σ: number
Scale parameter.
Returns
-------
quantile: Function
Quantile function.
Examples
--------
> var myQuantile = {{alias}}.factory( 4.0, 2.0 );
> var y = myQuantile( 0.2 )
~10.143
> y = myQuantile( 0.8 )
~293.901
See Also
--------