@stdlib/stats
Version:
Standard library statistical functions.
73 lines (56 loc) • 1.44 kB
Plain Text
{{alias}}( x, μ, b )
Evaluates the cumulative distribution function (CDF) for a Laplace
distribution with scale parameter `b` and location parameter `μ` at a
value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `b <= 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
μ: number
Location parameter.
b: number
Scale parameter.
Returns
-------
out: number
Evaluated CDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.0, 1.0 )
~0.932
> y = {{alias}}( 5.0, 10.0, 3.0 )
~0.094
> y = {{alias}}( NaN, 0.0, 1.0 )
NaN
> y = {{alias}}( 2, NaN, 1.0 )
NaN
> y = {{alias}}( 2.0, 0.0, NaN )
NaN
// Negative scale parameter:
> y = {{alias}}( 2.0, 0.0, -1.0 )
NaN
{{alias}}.factory( μ, b )
Returns a function for evaluating the cumulative distribution function (CDF)
of a Laplace distribution with scale parameter `b` and location parameter
`μ`.
Parameters
----------
μ: number
Location parameter.
b: number
Scale parameter.
Returns
-------
cdf: Function
Cumulative distribution function (CDF).
Examples
--------
> var myCDF = {{alias}}.factory( 2.0, 3.0 );
> var y = myCDF( 10.0 )
~0.965
> y = myCDF( 2.0 )
0.5
See Also
--------