@stdlib/stats
Version:
Standard library statistical functions.
80 lines (59 loc) • 1.56 kB
Plain Text
{{alias}}( p, μ, b )
Evaluates the quantile function for a Laplace distribution with scale
parameter `b` and location parameter `μ` at a probability `p`.
If `p < 0` or `p > 1`, the function returns `NaN`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `b <= 0`, the function returns `NaN`.
Parameters
----------
p: number
Input probability.
μ: number
Location parameter.
b: number
Scale parameter.
Returns
-------
out: number
Evaluated quantile function.
Examples
--------
> var y = {{alias}}( 0.8, 0.0, 1.0 )
~0.916
> y = {{alias}}( 0.5, 4.0, 2.0 )
4.0
> y = {{alias}}( 1.1, 0.0, 1.0 )
NaN
> y = {{alias}}( -0.2, 0.0, 1.0 )
NaN
> 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.5, 0.0, -1.0 )
NaN
{{alias}}.factory( μ, b )
Returns a function for evaluating the quantile function of a Laplace
distribution with scale parameter `b` and location parameter `μ`.
Parameters
----------
μ: number
Location parameter.
b: number
Scale parameter.
Returns
-------
quantile: Function
Quantile function.
Examples
--------
> var myQuantile = {{alias}}.factory( 10.0, 2.0 );
> var y = myQuantile( 0.5 )
10.0
> y = myQuantile( 0.8 )
~11.833
See Also
--------