@stdlib/stats
Version:
Standard library statistical functions.
82 lines (63 loc) • 1.65 kB
Plain Text
{{alias}}( x, α, β )
Evaluates the cumulative distribution function (CDF) for a beta prime
distribution with first shape parameter `α` and second shape parameter `β`
at a value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If `α <= 0` or `β <= 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
α: number
First shape parameter.
β: number
Second shape parameter.
Returns
-------
out: number
Evaluated CDF.
Examples
--------
> var y = {{alias}}( 0.5, 1.0, 1.0 )
~0.333
> y = {{alias}}( 0.5, 2.0, 4.0 )
~0.539
> y = {{alias}}( 0.2, 2.0, 2.0 )
~0.074
> y = {{alias}}( 0.8, 4.0, 4.0 )
~0.38
> y = {{alias}}( -0.5, 4.0, 2.0 )
0.0
> y = {{alias}}( 2.0, -1.0, 0.5 )
NaN
> y = {{alias}}( 2.0, 0.5, -1.0 )
NaN
> y = {{alias}}( NaN, 1.0, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, 1.0, NaN )
NaN
{{alias}}.factory( α, β )
Returns a function for evaluating the cumulative distribution function (CDF)
of a beta prime distribution with first shape parameter `α` and second shape
parameter `β`.
Parameters
----------
α: number
First shape parameter.
β: number
Second shape parameter.
Returns
-------
cdf: Function
Cumulative distribution function (CDF).
Examples
--------
> var mycdf = {{alias}}.factory( 0.5, 0.5 );
> var y = mycdf( 0.8 )
~0.465
> y = mycdf( 0.3 )
~0.319
See Also
--------