@stdlib/stats
Version:
Standard library statistical functions.
78 lines (59 loc) • 1.64 kB
Plain Text
{{alias}}( x, μ, σ )
Evaluates the natural logarithm of the cumulative distribution function
(CDF) for a normal distribution with mean `μ` and standard deviation `σ` 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
Standard deviation.
Returns
-------
out: number
Evaluated logcdf.
Examples
--------
> var y = {{alias}}( 2.0, 0.0, 1.0 )
~-0.023
> y = {{alias}}( -1.0, 4.0, 2.0 )
~-5.082
> y = {{alias}}( NaN, 0.0, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, 0.0, NaN )
NaN
// Negative standard deviation:
> y = {{alias}}( 2.0, 0.0, -1.0 )
NaN
// Degenerate distribution centered at `μ` when `σ = 0.0`:
> y = {{alias}}( 2.0, 8.0, 0.0 )
-Infinity
> y = {{alias}}( 8.0, 8.0, 0.0 )
0.0
{{alias}}.factory( μ, σ )
Returns a function for evaluating the natural logarithm of the cumulative
distribution function (CDF) of a normal distribution with mean `μ` and
standard deviation `σ`.
Parameters
----------
μ: number
Location parameter.
σ: number
Standard deviation.
Returns
-------
logcdf: Function
Logarithm of cumulative distribution function (CDF).
Examples
--------
> var mylogcdf = {{alias}}.factory( 10.0, 2.0 );
> var y = mylogcdf( 10.0 )
~-0.693
See Also
--------