@stdlib/stats
Version:
Standard library statistical functions.
90 lines (68 loc) • 1.79 kB
Plain Text
{{alias}}( r, n, p )
Evaluates the quantile function for a binomial distribution with number of
trials `n` and success probability `p` at a probability `r`.
If `r < 0` or `r > 1`, the function returns `NaN`.
If provided a number of trials `n` which is not a nonnegative integer, the
function returns `NaN`.
If `p < 0` or `p > 1`, the function returns `NaN`.
If provided `NaN` as any argument, the function returns `NaN`.
Parameters
----------
r: number
Input probability.
n: integer
Number of trials.
p: number
Success probability.
Returns
-------
out: number
Evaluated quantile function.
Examples
--------
> var y = {{alias}}( 0.4, 20, 0.2 )
3
> y = {{alias}}( 0.8, 20, 0.2 )
5
> y = {{alias}}( 0.5, 10, 0.4 )
4
> y = {{alias}}( 0.0, 10, 0.4 )
0
> y = {{alias}}( 1.0, 10, 0.4 )
10
> y = {{alias}}( NaN, 20, 0.5 )
NaN
> y = {{alias}}( 0.2, NaN, 0.5 )
NaN
> y = {{alias}}( 0.2, 20, NaN )
NaN
> y = {{alias}}( 0.5, 1.5, 0.5 )
NaN
> y = {{alias}}( 0.5, -2.0, 0.5 )
NaN
> y = {{alias}}( 0.5, 20, -1.0 )
NaN
> y = {{alias}}( 0.5, 20, 1.5 )
NaN
{{alias}}.factory( n, p )
Returns a function for evaluating the quantile function of a binomial
distribution with number of trials `n` and success probability `p`.
Parameters
----------
n: integer
Number of trials.
p: number
Success probability.
Returns
-------
quantile: Function
Quantile function.
Examples
--------
> var myquantile = {{alias}}.factory( 10, 0.5 );
> var y = myquantile( 0.1 )
3
> y = myquantile( 0.9 )
7
See Also
--------