G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentG01BLF

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

G01BLF returns the lower tail, upper tail and point probabilities associated with a hypergeometric distribution.

## 2  Specification

 SUBROUTINE G01BLF ( N, L, M, K, PLEK, PGTK, PEQK, IFAIL)
 INTEGER N, L, M, K, IFAIL REAL (KIND=nag_wp) PLEK, PGTK, PEQK

## 3  Description

Let $X$ denote a random variable having a hypergeometric distribution with parameters $n$, $l$ and $m$ ($n\ge l\ge 0$, $n\ge m\ge 0$). Then
 $ProbX=k= m k n-m l-k n l ,$
where $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(0,l-\left(n-m\right)\right)\le k\le \mathrm{min}\phantom{\rule{0.125em}{0ex}}\left(l,m\right)$, $0\le l\le n$ and $0\le m\le n$.
The hypergeometric distribution may arise if in a population of size $n$ a number $m$ are marked. From this population a sample of size $l$ is drawn and of these $k$ are observed to be marked.
The mean of the distribution $\text{}=\frac{lm}{n}$, and the variance $\text{}=\frac{lm\left(n-l\right)\left(n-m\right)}{{n}^{2}\left(n-1\right)}$.
G01BLF computes for given $n$, $l$, $m$ and $k$ the probabilities:
 $PLEK=ProbX≤k PGTK=ProbX>k PEQK=ProbX=k .$
The method is similar to the method for the Poisson distribution described in Knüsel (1986).

## 4  References

Knüsel L (1986) Computation of the chi-square and Poisson distribution SIAM J. Sci. Statist. Comput. 7 1022–1036

## 5  Parameters

1:     $\mathrm{N}$ – INTEGERInput
On entry: the parameter $n$ of the hypergeometric distribution.
Constraint: ${\mathbf{N}}\ge 0$.
2:     $\mathrm{L}$ – INTEGERInput
On entry: the parameter $l$ of the hypergeometric distribution.
Constraint: $0\le {\mathbf{L}}\le {\mathbf{N}}$.
3:     $\mathrm{M}$ – INTEGERInput
On entry: the parameter $m$ of the hypergeometric distribution.
Constraint: $0\le {\mathbf{M}}\le {\mathbf{N}}$.
4:     $\mathrm{K}$ – INTEGERInput
On entry: the integer $k$ which defines the required probabilities.
Constraint: $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(0,{\mathbf{L}}-\left({\mathbf{N}}-{\mathbf{M}}\right)\right)\le {\mathbf{K}}\le \mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{L}},{\mathbf{M}}\right)$.
5:     $\mathrm{PLEK}$ – REAL (KIND=nag_wp)Output
On exit: the lower tail probability, $\mathrm{Prob}\left\{X\le k\right\}$.
6:     $\mathrm{PGTK}$ – REAL (KIND=nag_wp)Output
On exit: the upper tail probability, $\mathrm{Prob}\left\{X>k\right\}$.
7:     $\mathrm{PEQK}$ – REAL (KIND=nag_wp)Output
On exit: the point probability, $\mathrm{Prob}\left\{X=k\right\}$.
8:     $\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, ${\mathbf{N}}<0$.
${\mathbf{IFAIL}}=2$
 On entry, ${\mathbf{L}}<0$, or ${\mathbf{L}}>{\mathbf{N}}$.
${\mathbf{IFAIL}}=3$
 On entry, ${\mathbf{M}}<0$, or ${\mathbf{M}}>{\mathbf{N}}$.
${\mathbf{IFAIL}}=4$
 On entry, ${\mathbf{K}}<0$, or ${\mathbf{K}}>{\mathbf{L}}$, or ${\mathbf{K}}>{\mathbf{M}}$, or ${\mathbf{K}}<{\mathbf{L}}+{\mathbf{M}}-{\mathbf{N}}$.
${\mathbf{IFAIL}}=5$
 On entry, N is too large to be represented exactly as a real number.
${\mathbf{IFAIL}}=6$
 On entry, the variance (see Section 3) exceeds ${10}^{6}$.
${\mathbf{IFAIL}}=-99$
An unexpected error has been triggered by this routine. Please contact NAG.
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

Results are correct to a relative accuracy of at least ${10}^{-6}$ on machines with a precision of $9$ or more decimal digits, and to a relative accuracy of at least ${10}^{-3}$ on machines of lower precision (provided that the results do not underflow to zero).

Not applicable.

## 9  Further Comments

The time taken by G01BLF depends on the variance (see Section 3) and on $k$. For given variance, the time is greatest when $k\approx lm/n$ ($=$ the mean), and is then approximately proportional to the square-root of the variance.

## 10  Example

This example reads values of $n$, $l$, $m$ and $k$ from a data file until end-of-file is reached, and prints the corresponding probabilities.

### 10.1  Program Text

Program Text (g01blfe.f90)

### 10.2  Program Data

Program Data (g01blfe.d)

### 10.3  Program Results

Program Results (g01blfe.r)