@stdlib/stats
Version:
Standard library statistical functions.
72 lines (54 loc) • 1.44 kB
Plain Text
{{alias}}( x, x0, Ɣ )
Evaluates the probability density function (PDF) for a Cauchy distribution
with location parameter `x0` and scale parameter `Ɣ` at a value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `Ɣ <= 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
x0: number
Location parameter.
Ɣ: number
Scale parameter.
Returns
-------
out: number
Evaluated PDF.
Examples
--------
> var y = {{alias}}( 2.0, 1.0, 1.0 )
~0.159
> y = {{alias}}( 4.0, 3.0, 0.1 )
~0.0315
> y = {{alias}}( 4.0, 3.0, 3.0 )
~0.095
> y = {{alias}}( NaN, 1.0, 1.0 )
NaN
> y = {{alias}}( 2.0, NaN, 1.0 )
NaN
> y = {{alias}}( 2.0, 1.0, NaN )
NaN
// Negative scale parameter:
> y = {{alias}}( 2.0, 1.0, -2.0 )
NaN
{{alias}}.factory( x0, Ɣ )
Returns a function for evaluating the probability density function (PDF) of
a Cauchy distribution with location parameter `x0` and scale parameter `Ɣ`.
Parameters
----------
x0: number
Location parameter.
Ɣ: number
Scale parameter.
Returns
-------
pdf: Function
Probability density function (PDF).
Examples
--------
> var myPDF = {{alias}}.factory( 10.0, 2.0 );
> var y = myPDF( 10.0 )
~0.159
See Also
--------