@stdlib/stats
Version:
Standard library statistical functions.
68 lines (51 loc) • 1.39 kB
Plain Text
{{alias}}( x, μ, s )
Evaluates the logarithm of the cumulative distribution function (CDF) for a
logistic distribution with location parameter `μ` and scale parameter `s` at
a value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `s < 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
μ: number
Location parameter.
s: number
Scale parameter.
Returns
-------
out: number
Evaluated logCDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.0, 1.0 )
~-0.127
> y = {{alias}}( 5.0, 10.0, 3.0 )
~-1.84
> y = {{alias}}( 2.0, 0.0, NaN )
NaN
> y = {{alias}}( 2, NaN, 1.0 )
NaN
> y = {{alias}}( NaN, 0.0, 1.0 )
NaN
{{alias}}.factory( μ, s )
Returns a function for evaluating the logarithm of the cumulative
distribution function (CDF) of a Logistic distribution with location
parameter `μ` and scale parameter `s`.
Parameters
----------
μ: number
Location parameter.
s: number
Scale parameter.
Returns
-------
logcdf: Function
Logarithm of cumulative distribution function (CDF).
Examples
--------
> var mylogcdf = {{alias}}.factory( 3.0, 1.5 );
> var y = mylogcdf( 1.0 )
~-1.567
See Also
--------