@stdlib/stats
Version:
Standard library statistical functions.
76 lines (57 loc) • 1.54 kB
Plain Text
{{alias}}( x, μ, σ )
Evaluates the probability density function (PDF) for a normal distribution
with mean `μ` and standard deviation `σ` 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.
μ: number
Location parameter.
σ: number
Standard deviation.
Returns
-------
out: number
Evaluated PDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.0, 1.0 )
~0.054
> y = {{alias}}( -1.0, 4.0, 2.0 )
~0.009
> 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 standard deviation:
> y = {{alias}}( 2.0, 0.0, -1.0 )
NaN
// Degenerate distribution centered at `μ` when `σ = 0.0`:
> y = {{alias}}( 2.0, 8.0, 0.0 )
0.0
> y = {{alias}}( 8.0, 8.0, 0.0 )
infinity
{{alias}}.factory( μ, σ )
Returns a function for evaluating the probability density function (PDF) of
a normal distribution with mean `μ` and standard deviation `σ`.
Parameters
----------
μ: number
Location parameter.
σ: number
Standard deviation.
Returns
-------
pdf: Function
Probability density function (PDF).
Examples
--------
> var myPDF = {{alias}}.factory( 10.0, 2.0 );
> var y = myPDF( 10.0 )
~0.199
See Also
--------