# NAG Library Routine Document

## 1Purpose

g05tef generates a vector of pseudorandom integers from the discrete hypergeometric distribution of the number of specified items in a sample of size $l$, taken from a population of size $k$ with $m$ specified items in it.

## 2Specification

Fortran Interface
 Subroutine g05tef ( mode, n, ns, np, m, r, lr, x,
 Integer, Intent (In) :: mode, n, ns, np, m, lr Integer, Intent (Inout) :: state(*), ifail Integer, Intent (Out) :: x(n) Real (Kind=nag_wp), Intent (Inout) :: r(lr)
C Header Interface
#include nagmk26.h
 void g05tef_ (const Integer *mode, const Integer *n, const Integer *ns, const Integer *np, const Integer *m, double r[], const Integer *lr, Integer state[], Integer x[], Integer *ifail)

## 3Description

g05tef generates $n$ integers ${x}_{i}$ from a discrete hypergeometric distribution, where the probability of ${x}_{i}=I$ is
The variates can be generated with or without using a search table and index. If a search table is used then it is stored with the index in a reference vector and subsequent calls to g05tef with the same parameter values can then use this reference vector to generate further variates. The reference array is generated by a recurrence relation if $lm\left(k-l\right)\left(k-m\right)<50{k}^{3}$, otherwise Stirling's approximation is used.
One of the initialization routines g05kff (for a repeatable sequence if computed sequentially) or g05kgf (for a non-repeatable sequence) must be called prior to the first call to g05tef.

## 4References

Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley

## 5Arguments

1:     $\mathbf{mode}$ – IntegerInput
On entry: a code for selecting the operation to be performed by the routine.
${\mathbf{mode}}=0$
Set up reference vector only.
${\mathbf{mode}}=1$
Generate variates using reference vector set up in a prior call to g05tef.
${\mathbf{mode}}=2$
Set up reference vector and generate variates.
${\mathbf{mode}}=3$
Generate variates without using the reference vector.
Constraint: ${\mathbf{mode}}=0$, $1$, $2$ or $3$.
2:     $\mathbf{n}$ – IntegerInput
On entry: $n$, the number of pseudorandom numbers to be generated.
Constraint: ${\mathbf{n}}\ge 0$.
3:     $\mathbf{ns}$ – IntegerInput
On entry: $l$, the sample size of the hypergeometric distribution.
Constraint: $0\le {\mathbf{ns}}\le {\mathbf{np}}$.
4:     $\mathbf{np}$ – IntegerInput
On entry: $k$, the population size of the hypergeometric distribution.
Constraint: ${\mathbf{np}}\ge 0$.
5:     $\mathbf{m}$ – IntegerInput
On entry: $m$, the number of specified items of the hypergeometric distribution.
Constraint: $0\le {\mathbf{m}}\le {\mathbf{np}}$.
6:     $\mathbf{r}\left({\mathbf{lr}}\right)$ – Real (Kind=nag_wp) arrayCommunication Array
On entry: if ${\mathbf{mode}}=1$, the reference vector from the previous call to g05tef.
If ${\mathbf{mode}}=3$, r is not referenced.
On exit: if ${\mathbf{mode}}\ne 3$, the reference vector.
7:     $\mathbf{lr}$ – IntegerInput
On entry: the dimension of the array r as declared in the (sub)program from which g05tef is called.
Suggested values:
• if ${\mathbf{mode}}\ne 3$, ${\mathbf{lr}}=28+20×\sqrt{\left({\mathbf{ns}}×{\mathbf{m}}×\left({\mathbf{np}}-{\mathbf{m}}\right)×\left({\mathbf{np}}-{\mathbf{ns}}\right)\right)/{{\mathbf{np}}}^{3}}$ approximately;
• otherwise ${\mathbf{lr}}=1$.
Constraints:
• if ${\mathbf{mode}}=0$ or $2$, lr must not be too small, but the limit is too complicated to specify;
• if ${\mathbf{mode}}=1$, lr must remain unchanged from the previous call to g05tef.
8:     $\mathbf{state}\left(*\right)$ – Integer arrayCommunication Array
Note: the actual argument supplied must be the array state supplied to the initialization routines g05kff or g05kgf.
On entry: contains information on the selected base generator and its current state.
On exit: contains updated information on the state of the generator.
9:     $\mathbf{x}\left({\mathbf{n}}\right)$ – Integer arrayOutput
On exit: the pseudorandom numbers from the specified hypergeometric distribution.
10:   $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-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{mode}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{mode}}=0$, $1$, $2$ or $3$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 0$.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{ns}}=〈\mathit{\text{value}}〉$ and ${\mathbf{np}}=〈\mathit{\text{value}}〉$.
Constraint: $0\le {\mathbf{ns}}\le {\mathbf{np}}$.
${\mathbf{ifail}}=4$
On entry, ${\mathbf{np}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{np}}\ge 0$.
${\mathbf{ifail}}=5$
On entry, ${\mathbf{m}}=〈\mathit{\text{value}}〉$ and ${\mathbf{np}}=〈\mathit{\text{value}}〉$.
Constraint: $0\le {\mathbf{m}}\le {\mathbf{np}}$.
${\mathbf{ifail}}=6$
On entry, some of the elements of the array r have been corrupted or have not been initialized.
The value of ns, np or m is not the same as when r was set up in a previous call with ${\mathbf{mode}}=0$ or $2$.
${\mathbf{ifail}}=7$
On entry, lr is too small when ${\mathbf{mode}}=0$ or $2$: ${\mathbf{lr}}=〈\mathit{\text{value}}〉$, minimum length required $\text{}=〈\mathit{\text{value}}〉$.
${\mathbf{ifail}}=8$
On entry, state vector has been corrupted or not initialized.
${\mathbf{ifail}}=-99$
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

Not applicable.

## 8Parallelism and Performance

g05tef is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

None.

## 10Example

The example program prints $20$ pseudorandom integers from a hypergeometric distribution with $l=500$, $m=900$ and $n=1000$, generated by a single call to g05tef, after initialization by g05kff.

### 10.1Program Text

Program Text (g05tefe.f90)

### 10.2Program Data

Program Data (g05tefe.d)

### 10.3Program Results

Program Results (g05tefe.r)

© The Numerical Algorithms Group Ltd, Oxford, UK. 2017