@stdlib/stats
Version:
Standard library statistical functions.
85 lines (65 loc) • 1.74 kB
Plain Text
{{alias}}( p, α, s, m )
Evaluates the quantile function for a Fréchet distribution with shape
parameter `α`, scale parameter `s`, and location `m`.
If `p < 0` or `p > 1`, the function returns `NaN`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `α <= 0` or `s <= 0`, the function returns `NaN`.
Parameters
----------
p: number
Input probability.
α: number
Shape parameter.
s: number
Scale parameter.
m: number
Location parameter.
Returns
-------
out: number
Evaluated quantile function.
Examples
--------
> var y = {{alias}}( 0.3, 10.0, 2.0, 3.0 )
~4.963
> y = {{alias}}( 0.2, 3.0, 3.0, 3.0 )
~5.56
> y = {{alias}}( 0.9, 1.0, 1.0, -3.0 )
~6.491
> 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 quantile function 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
-------
quantile: Function
Quantile function.
Examples
--------
> var myQuantile = {{alias}}.factory( 2.0, 2.0, 3.0 );
> var y = myQuantile( 0.5 )
~5.402
> y = myQuantile( 0.2 )
~4.576
See Also
--------