NAG Library Routine Document

G05TEF

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.

+− Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Further Comments

+− 9 Example

9.1 Program Text

9.2 Program Data

9.3 Program Results

1 Purpose

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.

2 Specification

SUBROUTINE G05TEF ( MODE, N, NS, NP, M, R, LR, STATE, X, IFAIL)

INTEGER MODE, N, NS, NP, M, LR, STATE(*), X(N), IFAIL

REAL (KIND=nag_wp) R(LR)

3 Description

G05TEF generates

n

integers

x_{i}

from a discrete hypergeometric distribution, where the probability of

x_{i} = I

\begin{matrix} P (i = I) = \frac{l! m! (k - l)! (k - m)!}{I! (l - I)! (m - I)! (k - m - l + I)! k!} & if I = \max (0, m + l - k), \dots, \min (l, m), \\ P (i = I) = 0 & otherwise. \end{matrix}

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

l m (k - l) (k - m) < 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.

4 References

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

5 Parameters

1: MODE – INTEGERInput

On entry: a code for selecting the operation to be performed by the routine.

$MODE = 0$: Set up reference vector only.
$MODE = 1$: Generate variates using reference vector set up in a prior call to G05TEF.
$MODE = 2$: Set up reference vector and generate variates.
$MODE = 3$: Generate variates without using the reference vector.

Constraint:

MODE = 0

1

2

3

2: N – INTEGERInput

On entry:

n

, the number of pseudorandom numbers to be generated.

Constraint:

N \geq 0

3: NS – INTEGERInput

On entry:

l

, the sample size of the hypergeometric distribution.

Constraint:

0 \leq NS \leq NP

4: NP – INTEGERInput

On entry:

k

, the population size of the hypergeometric distribution.

Constraint:

NP \geq 0

5: M – INTEGERInput

On entry:

m

, the number of specified items of the hypergeometric distribution.

Constraint:

0 \leq M \leq NP

6: R(LR) – REAL (KIND=nag_wp) arrayCommunication Array

On entry: if

MODE = 1

, the reference vector from the previous call to G05TEF.

MODE = 3

, R is not referenced by G05TEF.

On exit: the reference vector.

7: LR – INTEGERInput

On entry: the dimension of the array R as declared in the (sub)program from which G05TEF is called.

Suggested values:

if $MODE \neq 3$ , $LR = 28 + 20 \times \sqrt{(NS \times M \times (NP - M) \times (NP - NS)) / {NP}^{3}}$ approximately;
otherwise $LR = 1$ .

Constraints:

if $MODE = 0$ or $2$ , LR must not be too small, but the limit is too complicated to specify;
if $MODE = 1$ , LR must remain unchanged from the previous call to G05TEF.

8: STATE( $*$ ) – 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: X(N) – INTEGER arrayOutput

On exit: the pseudorandom numbers from the specified hypergeometric distribution.

10: IFAIL – INTEGERInput/Output

On entry: IFAIL must be set to

0

- 1 ​ 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 ​ 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 $- 1 or 1$ is used it is essential to test the value of IFAIL on exit.

On exit:

IFAIL = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

IFAIL = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by X04AAF).

Errors or warnings detected by the routine:

$IFAIL = 1$: On entry, $MODE \neq 0$ , $1$ , $2$ or $3$ .

$IFAIL = 2$: On entry, $N < 0$ .

$IFAIL = 3$: On entry, $NS > NP$ ,
or $NS < 0$ .

$IFAIL = 4$: On entry, $NP < 0$ .

$IFAIL = 5$: On entry, $M > NP$ ,
or $M < 0$ .

$IFAIL = 6$: On entry, at least one of NS, NP or M is not the same as when R was set up in a previous call to G05TEF with $MODE = 0$ or $2$ .

On entry, the R vector was not initialized correctly or has been corrupted.

$IFAIL = 7$: On entry, LR is too small when $MODE = 0$ or $2$ .

$IFAIL = 8$: On entry, STATE vector was not initialized or has been corrupted.

7 Accuracy

Not applicable.

8 Further Comments

None.

9 Example

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.

NAG Library Routine DocumentG05TEF

+− Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Further Comments

9 Example

9.1 Program Text

9.2 Program Data

9.3 Program Results

NAG Library Routine Document

G05TEF