Interface Quantile

Interface for the quantile function of a beta distribution.

Hierarchy

Quantile

Callable

__call(p: number, alpha: number, beta: number): number

- Defined in lib/node_modules/@stdlib/stats/base/dists/beta/quantile/docs/types/index.d.ts:36
Evaluates the quantile function for a beta distribution with first shape parameter alpha and second shape parameter beta at a probability p.

Notes
- If p < 0 or p > 1, the function returns NaN.
- If alpha <= 0 or beta <= 0, the function returns NaN.
Parameters
- p: number
  
  input value
- alpha: number
  
  first shape parameter
- beta: number
  
  second shape parameter
Returns number

evaluated quantile function

Example
```
var y = quantile( 0.8, 2.0, 1.0 );
// returns ~0.894
```
Example
```
var y = quantile( 0.5, 4.0, 2.0 );
// returns ~0.686
```
Example
```
var y = quantile( 1.1, 1.0, 1.0 );
// returns NaN
```
Example
```
var y = quantile( -0.2, 1.0, 1.0 );
// returns NaN
```
Example
```
var y = quantile( NaN, 1.0, 1.0 );
// returns NaN
```
Example
```
var y = quantile( 0.5, NaN, 1.0 );
// returns NaN
```
Example
```
var y = quantile( 0.5, 1.0, NaN );
// returns NaN
```
Example
```
var y = quantile( 0.5, -1.0, 1.0 );
// returns NaN
```
Example
```
var y = quantile( 0.5, 1.0, -1.0 );
// returns NaN
```

Index

Methods

factory

Methods

factory

factory(alpha: number, beta: number): Unary

- Defined in lib/node_modules/@stdlib/stats/base/dists/beta/quantile/docs/types/index.d.ts:103
Returns a function for evaluating the quantile function for a beta distribution with first shape parameter alpha and second shape parameter beta.

Parameters
- alpha: number
  
  first shape parameter
- beta: number
  
  second shape parameter
Returns Unary

quantile function

Example
```
var myQuantile = quantile.factory( 2.5, 0.5 );
var y = myQuantile( 0.5 );
// returns ~0.904

y = myQuantile( 0.8 );
// returns ~0.986
```