G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentG01SFF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

G01SFF returns a number of lower or upper tail probabilities for the gamma distribution.

## 2  Specification

 SUBROUTINE G01SFF ( LTAIL, TAIL, LG, G, LA, A, LB, B, P, IVALID, IFAIL)
 INTEGER LTAIL, LG, LA, LB, IVALID(*), IFAIL REAL (KIND=nag_wp) G(LG), A(LA), B(LB), P(*) CHARACTER(1) TAIL(LTAIL)

## 3  Description

The lower tail probability for the gamma distribution with parameters ${\alpha }_{i}$ and ${\beta }_{i}$, $P\left({G}_{i}\le {g}_{i}\right)$, is defined by:
 $P Gi ≤ gi :αi,βi = 1 βi αi Γ αi ∫ 0 gi Gi αi-1 e -Gi/βi dGi , αi>0.0 , ​ βi>0.0 .$
The mean of the distribution is ${\alpha }_{i}{\beta }_{i}$ and its variance is ${\alpha }_{i}{{\beta }_{i}}^{2}$. The transformation ${Z}_{i}=\frac{{G}_{i}}{{\beta }_{i}}$ is applied to yield the following incomplete gamma function in normalized form,
 $P Gi ≤ gi :αi,βi = P Zi ≤ gi / βi :αi,1.0 = 1 Γ αi ∫ 0 gi / βi Zi αi-1 e -Zi dZi .$
This is then evaluated using S14BAF.
The input arrays to this routine are designed to allow maximum flexibility in the supply of vector parameters by re-using elements of any arrays that are shorter than the total number of evaluations required. See Section 2.6 in the G01 Chapter Introduction for further information.

## 4  References

Hastings N A J and Peacock J B (1975) Statistical Distributions Butterworth

## 5  Parameters

1:     $\mathrm{LTAIL}$ – INTEGERInput
On entry: the length of the array TAIL.
Constraint: ${\mathbf{LTAIL}}>0$.
2:     $\mathrm{TAIL}\left({\mathbf{LTAIL}}\right)$ – CHARACTER(1) arrayInput
On entry: indicates whether a lower or upper tail probability is required. For , for $\mathit{i}=1,2,\dots ,\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{LTAIL}},{\mathbf{LG}},{\mathbf{LA}},{\mathbf{LB}}\right)$:
${\mathbf{TAIL}}\left(j\right)=\text{'L'}$
The lower tail probability is returned, i.e., ${p}_{i}=P\left({G}_{i}\le {g}_{i}:{\alpha }_{i},{\beta }_{i}\right)$.
${\mathbf{TAIL}}\left(j\right)=\text{'U'}$
The upper tail probability is returned, i.e., ${p}_{i}=P\left({G}_{i}\ge {g}_{i}:{\alpha }_{i},{\beta }_{i}\right)$.
Constraint: ${\mathbf{TAIL}}\left(\mathit{j}\right)=\text{'L'}$ or $\text{'U'}$, for $\mathit{j}=1,2,\dots ,{\mathbf{LTAIL}}$.
3:     $\mathrm{LG}$ – INTEGERInput
On entry: the length of the array G.
Constraint: ${\mathbf{LG}}>0$.
4:     $\mathrm{G}\left({\mathbf{LG}}\right)$ – REAL (KIND=nag_wp) arrayInput
On entry: ${g}_{i}$, the value of the gamma variate with ${g}_{i}={\mathbf{G}}\left(j\right)$, .
Constraint: ${\mathbf{G}}\left(\mathit{j}\right)\ge 0.0$, for $\mathit{j}=1,2,\dots ,{\mathbf{LG}}$.
5:     $\mathrm{LA}$ – INTEGERInput
On entry: the length of the array A.
Constraint: ${\mathbf{LA}}>0$.
6:     $\mathrm{A}\left({\mathbf{LA}}\right)$ – REAL (KIND=nag_wp) arrayInput
On entry: the parameter ${\alpha }_{i}$ of the gamma distribution with ${\alpha }_{i}={\mathbf{A}}\left(j\right)$, .
Constraint: ${\mathbf{A}}\left(\mathit{j}\right)>0.0$, for $\mathit{j}=1,2,\dots ,{\mathbf{LA}}$.
7:     $\mathrm{LB}$ – INTEGERInput
On entry: the length of the array B.
Constraint: ${\mathbf{LB}}>0$.
8:     $\mathrm{B}\left({\mathbf{LB}}\right)$ – REAL (KIND=nag_wp) arrayInput
On entry: the parameter ${\beta }_{i}$ of the gamma distribution with ${\beta }_{i}={\mathbf{B}}\left(j\right)$, .
Constraint: ${\mathbf{B}}\left(\mathit{j}\right)>0.0$, for $\mathit{j}=1,2,\dots ,{\mathbf{LB}}$.
9:     $\mathrm{P}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput
Note: the dimension of the array P must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{LG}},{\mathbf{LA}},{\mathbf{LB}},{\mathbf{LTAIL}}\right)$.
On exit: ${p}_{i}$, the probabilities of the beta distribution.
10:   $\mathrm{IVALID}\left(*\right)$ – INTEGER arrayOutput
Note: the dimension of the array IVALID must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{LG}},{\mathbf{LA}},{\mathbf{LB}},{\mathbf{LTAIL}}\right)$.
On exit: ${\mathbf{IVALID}}\left(i\right)$ indicates any errors with the input arguments, with
${\mathbf{IVALID}}\left(i\right)=0$
No error.
${\mathbf{IVALID}}\left(i\right)=1$
 On entry, invalid value supplied in TAIL when calculating ${p}_{i}$.
${\mathbf{IVALID}}\left(i\right)=2$
 On entry, ${g}_{i}<0.0$.
${\mathbf{IVALID}}\left(i\right)=3$
 On entry, ${\alpha }_{i}\le 0.0$, or ${\beta }_{i}\le 0.0$.
${\mathbf{IVALID}}\left(i\right)=4$
The solution did not converge in $600$ iterations, see S14BAF for details. The probability returned should be a reasonable approximation to the solution.
11:   $\mathrm{IFAIL}$ – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ or ​}1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
On entry, at least one value of G, A, B or TAIL was invalid, or the solution did not converge.
${\mathbf{IFAIL}}=2$
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{LTAIL}}>0$.
${\mathbf{IFAIL}}=3$
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{LG}}>0$.
${\mathbf{IFAIL}}=4$
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{LA}}>0$.
${\mathbf{IFAIL}}=5$
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{LB}}>0$.
${\mathbf{IFAIL}}=-99$
See Section 3.8 in the Essential Introduction for further information.
${\mathbf{IFAIL}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.
${\mathbf{IFAIL}}=-999$
Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

## 7  Accuracy

The result should have a relative accuracy of machine precision. There are rare occasions when the relative accuracy attained is somewhat less than machine precision but the error should not exceed more than $1$ or $2$ decimal places.

## 8  Parallelism and Performance

Not applicable.

The time taken by G01SFF to calculate each probability varies slightly with the input parameters ${g}_{i}$, ${\alpha }_{i}$ and ${\beta }_{i}$.

## 10  Example

This example reads in values from a number of gamma distributions and computes the associated lower tail probabilities.

### 10.1  Program Text

Program Text (g01sffe.f90)

### 10.2  Program Data

Program Data (g01sffe.d)

### 10.3  Program Results

Program Results (g01sffe.r)