@stdlib/stats
Version:
Standard library statistical functions.
84 lines (65 loc) • 1.71 kB
Plain Text
{{alias}}( x, α, s, m )
Evaluates the cumulative distribution function (CDF) for a Fréchet
distribution with shape parameter `α`, scale parameter `s`, and location
`m`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `α <= 0` or `s <= 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
α: number
Shape parameter.
s: number
Scale parameter.
m: number
Location parameter.
Returns
-------
out: number
Evaluated CDF.
Examples
--------
> var y = {{alias}}( 10.0, 2.0, 3.0, 0.0 )
~0.914
> y = {{alias}}( -1.0, 2.0, 3.0, -3.0 )
~0.105
> y = {{alias}}( 2.5, 2.0, 1.0, 2.0 )
~0.018
> y = {{alias}}( NaN, 1.0, 1.0, 0.0 )
NaN
> y = {{alias}}( 0.0, NaN, 1.0, 0.0 )
NaN
> y = {{alias}}( 0.0, 1.0, NaN, 0.0 )
NaN
> y = {{alias}}( 0.0, 1.0, 1.0, NaN )
NaN
> y = {{alias}}( 0.0, -1.0, 1.0, 0.0 )
NaN
> y = {{alias}}( 0.0, 1.0, -1.0, 0.0 )
NaN
{{alias}}.factory( α, s, m )
Returns a function for evaluating the cumulative distribution function (CDF)
of a Fréchet distribution with shape parameter `α`, scale parameter `s`, and
location `m`.
Parameters
----------
α: number
Shape parameter.
s: number
Scale parameter.
m: number
Location parameter.
Returns
-------
cdf: Function
Cumulative distribution function (CDF).
Examples
--------
> var myCDF = {{alias}}.factory( 3.0, 3.0, 5.0 );
> var y = myCDF( 10.0 )
~0.806
> y = myCDF( 7.0 )
~0.034
See Also
--------