NAG Library Routine Document

G01BLF

1  Purpose

2  Specification

3  Description

4  References

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: $\max \left(0,\mathbf{L}-\left(\mathbf{N}-\mathbf{M}\right)\right)\le \mathbf{K}\le \min \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

$\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

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (g01blfe.f90)

10.2  Program Data

Program Data (g01blfe.d)

10.3  Program Results

Program Results (g01blfe.r)