Integer, Intent (In)	::	mode, n, lr
Integer, Intent (Inout)	::	state(*), ifail
Integer, Intent (Out)	::	x(n)
Real (Kind=nag_wp), Intent (In)	::	p
Real (Kind=nag_wp), Intent (Inout)	::	r(lr)

C Header Interface

#include <nag.h>

void	g05tcf_ (const Integer mode, const Integer n, const double p, double r[], const Integer lr, Integer state[], Integer x[], Integer *ifail)

The routine may be called by the names g05tcf or nagf_rand_int_geom.

3 Description

g05tcf generates

n

integers

x_{i}

from a discrete geometric distribution, where the probability of

x_{i} = I

(a first success after

I + 1

trials) is

P (x_{i} = I) = p \times {(1 - p)}^{I}, I = 0, 1, \dots .

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 g05tcf with the same parameter value can then use this reference vector to generate further variates. If the search table is not used (as recommended for small values of

p

) then a direct transformation of uniform variates 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 g05tcf.

4 References

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

5 Arguments

1: $mode$ – Integer Input

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 g05tcf.
$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$ – Integer Input

On entry:

n

, the number of pseudorandom numbers to be generated.

Constraint:

n \geq 0

3: $p$ – Real (Kind=nag_wp) Input

On entry: the parameter

p

of the geometric distribution representing the probability of success at a single trial.

Constraint:

machine precision \leq p \leq 1.0

(see x02ajf).

4: $r (lr)$ – Real (Kind=nag_wp) array Communication Array

On entry: if

mode = 1

, the reference vector from the previous call to g05tcf.

mode = 3

, r is not referenced.

On exit: if

mode \neq 3

, the reference vector.

5: $lr$ – Integer Input

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

Suggested values:

if $mode \neq 3$ , $lr = 8 + 42 / p$ approximately (see Section 9);
otherwise $lr = 1$ .

Constraints:

if $mode = 0$ or $2$ , $lr \geq 30 / p + 8$ ;
if $mode = 1$ , lr should remain unchanged from the previous call to g05tcf.

6: $state (*)$ – Integer array Communication 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.

7: $x (n)$ – Integer array Output

On exit: the

n

pseudorandom numbers from the specified geometric distribution.

8: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. 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 = ⟨ value ⟩$ .
Constraint: $mode = 0$ , $1$ , $2$ or $3$ .

$ifail = 2$: On entry, $n = ⟨ value ⟩$ .
Constraint: $n \geq 0$ .

$ifail = 3$: On entry, $p = ⟨ value ⟩$ .
Constraint: $machine precision \leq p \leq 1.0$ .

p is so small that lr would have to be larger than the largest representable integer. Use $mode = 3$ instead. $p = ⟨ value ⟩$

$ifail = 4$: On entry, some of the elements of the array r have been corrupted or have not been initialized.

p is not the same as when r was set up in a previous call.
Previous value of $p = ⟨ value ⟩$ and $p = ⟨ value ⟩$ .

$ifail = 5$: On entry, lr is too small when $mode = 0$ or $2$ : $lr = ⟨ value ⟩$ , minimum length required $= ⟨ value ⟩$ .

$ifail = 6$: On entry, state vector has been corrupted or not initialized.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

g05tcf 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.

9 Further Comments

The time taken to set up the reference vector, if used, increases with the length of array r. However, if the reference vector is used, the time taken to generate numbers decreases as the space allotted to the index part of r increases. Nevertheless, there is a point, depending on the distribution, where this improvement becomes very small and the suggested value for the length of array r is designed to approximate this point.

If p is very small then the storage requirements for the reference vector and the time taken to set up the reference vector becomes prohibitive. In this case it is recommended that the reference vector is not used. This is achieved by selecting

mode = 3

10 Example

This example prints

10

pseudorandom integers from a geometric distribution with parameter

p = 0.001

, generated by a single call to g05tcf, after initialization by g05kff.

g05tc: FL CL CPP AD PY MB

NAG FL Interfaceg05tcf (int_​geom)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
g05tcf (int_geom)