@stdlib/stats
Version:
Standard library statistical functions.
77 lines (58 loc) • 1.51 kB
Plain Text
{{alias}}( x, μ, σ )
Evaluates the cumulative distribution function (CDF) for a lognormal
distribution with location parameter `μ` and scale parameter `σ` at a value
`x`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `σ <= 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
μ: number
Location parameter.
σ: number
Scale parameter.
Returns
-------
out: number
Evaluated CDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.0, 1.0 )
~0.756
> y = {{alias}}( 5.0, 10.0, 3.0 )
~0.003
> y = {{alias}}( 2.0, 0.0, NaN )
NaN
> y = {{alias}}( 2.0, NaN, 1.0 )
NaN
> y = {{alias}}( NaN, 0.0, 1.0 )
NaN
// Non-positive scale parameter `σ`:
> y = {{alias}}( 2.0, 0.0, -1.0 )
NaN
> y = {{alias}}( 2.0, 0.0, 0.0 )
NaN
{{alias}}.factory( μ, σ )
Returns a function for evaluating the cumulative distribution function (CDF)
of a lognormal distribution with location parameter `μ` and scale parameter
`σ`.
Parameters
----------
μ: number
Location parameter.
σ: number
Scale parameter.
Returns
-------
cdf: Function
Cumulative distribution function (CDF).
Examples
--------
> var myCDF = {{alias}}.factory( 3.0, 1.5 );
> var y = myCDF( 1.0 )
~0.023
> y = myCDF( 4.0 )
~0.141
See Also
--------