@stdlib/stats
Version:
Standard library statistical functions.
80 lines (61 loc) • 1.59 kB
Plain Text
{{alias}}( x, α, s, m )
Evaluates the probability density function (PDF) 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 PDF.
Examples
--------
> var y = {{alias}}( 10.0, 0.0, 3.0 )
~0.965
> y = {{alias}}( -2.0, 0.0, 3.0 )
~0.143
> y = {{alias}}( 0.0, 0.0, 1.0 )
~0.368
> 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 scale parameter:
> y = {{alias}}( 0.0, 0.0, -1.0 )
NaN
{{alias}}.factory( α, s, m )
Returns a function for evaluating the probability density function (PDF) 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
-------
pdf: Function
Probability density function (PDF).
Examples
--------
> var myPDF = {{alias}}.factory( 2.0, 3.0 );
> var y = myPDF( 10.0 )
~0.933
> y = myPDF( 2.0 )
~0.368
See Also
--------