g05kgf initializes the selected base generator to generate a non-repeatable sequence of variates. The base generator can then be used by the group of pseudorandom number routines (see g05khf–g05kjf, g05ncf, g05ndf, g05pdf–g05pjf, g05pxf–g05pzf, g05rcf, g05rdf, g05ryf, g05rzf and g05saf–g05tlf) and the quasi-random scrambled sequence initialization routine, g05ynf.

2 Specification

Fortran Interface

Subroutine g05kgf (

genid, subid, state, lstate, ifail)

Integer, Intent (In)	::	genid, subid
Integer, Intent (Inout)	::	state(lstate), lstate, ifail

C Header Interface

#include <nag.h>

void	g05kgf_ (const Integer genid, const Integer subid, Integer state[], Integer lstate, Integer ifail)

The routine may be called by the names g05kgf or nagf_rand_init_nonrepeat.

3 Description

g05kgf selects a base generator through the input value of the arguments genid and subid, and then initializes it based on the values taken from the real-time clock, resulting in the same base generator yielding different sequences of random numbers each time the calling program is run. It should be noted that there is no guarantee of statistical properties between sequences, only within sequences.

A definition of some of the terms used in this description, along with details of the various base generators can be found in the G05 Chapter Introduction.

4 References

L'Ecuyer P and Simard R (2002) TestU01: a software library in ANSI C for empirical testing of random number generators Departement d'Informatique et de Recherche Operationnelle, Universite de Montreal https://www.iro.umontreal.ca/~lecuyer

Maclaren N M (1989) The generation of multiple independent sequences of pseudorandom numbers Appl. Statist. 38 351–359

Matsumoto M and Nishimura T (1998) Mersenne twister: a 623-dimensionally equidistributed uniform pseudorandom number generator ACM Transactions on Modelling and Computer Simulations

Wichmann B A and Hill I D (2006) Generating good pseudo-random numbers Computational Statistics and Data Analysis 51 1614–1622

Wikramaratna R S (1989) ACORN - a new method for generating sequences of uniformly distributed pseudo-random numbers Journal of Computational Physics 83 16–31

5 Arguments

1: $genid$ – Integer Input

On entry: must contain the type of base generator to use.

$genid = 1$: NAG basic generator.
$genid = 2$: Wichmann Hill I generator.
$genid = 3$: Mersenne Twister.
$genid = 4$: Wichmann Hill II generator.
$genid = 5$: ACORN generator.
$genid = 6$: L'Ecuyer MRG32k3a generator.

See the G05 Chapter Introduction for details of each of the base generators.

Constraint:

genid = 1

2

3

4

5

6

2: $subid$ – Integer Input

On entry: if

genid = 2

, subid indicates which of the

273

sub-generators to use. In this case, the

((| subid | + 272) mod 273) + 1

sub-generator is used.

genid = 5

, subid indicates the values of

k

and

p

to use, where

k

is the order of the generator, and

p

controls the size of the modulus,

M

, with

M = 2^{(p \times 30)}

. If

subid < 1

, the default values of

k = 10

and

p = 2

are used, otherwise values for

k

and

p

are calculated from the formula,

subid = k + 1000 (p - 1)

genid = 6

and

subid mod 2 = 0

the range of the generator is set to

(0, 1]

, otherwise the range is set to

(0, 1)

; in this case the sequence is identical to the implementation of MRG32k3a in TestU01 (see L'Ecuyer and Simard (2002)) for identical seeds.

For all other values of genid, subid is not referenced.

3: $state (lstate)$ – Integer array Communication Array

On exit: contains information on the selected base generator and its current state.

4: $lstate$ – Integer Input/Output

On entry: the dimension of the state array, or a value

< 1

. If the Mersenne Twister (

genid = 3

) is being used and the skip ahead routine g05kjf or g05kkf will be called subsequently, then you must ensure that

lstate \geq 1260

On exit: if

lstate < 1

on entry, then the required length of the state array for the chosen base generator, otherwise lstate is unchanged. When

genid = 3

(Mersenne Twister) a value of

1260

is returned, allowing for the skip ahead routine to be subsequently called. In all other cases the minimum length, as documented in the constraints below, is returned.

Constraints:

if $genid = 1$ , $lstate \geq 17$ ;
if $genid = 2$ , $lstate \geq 21$ ;
if $genid = 3$ , $lstate \geq 633$ ;
if $genid = 4$ , $lstate \geq 29$ ;
if $genid = 5$ , $lstate \geq \max ((k + 1) \times p + 9, 14) + 3$ , where $k$ and $p$ are defined by subid;
if $genid = 6$ , $lstate \geq 61$ ;
otherwise $lstate < 1$ .

5: $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, $genid = ⟨ value ⟩$ .
Constraint: $genid = 1$ , $2$ , $3$ , $4$ , $5$ or $6$ .

$ifail = 4$: On entry, $lstate = ⟨ value ⟩$ .
Constraint: $lstate \leq 0$ or $lstate \geq ⟨ value ⟩$ .

$ifail = - 1$: Required length of state array returned in lstate but state array 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.

g05kgf is not threaded in any implementation.

9 Further Comments

None.

10 Example

In order to preserve the statistical properties of the base generators, g05kgf should only be called once. If multiple streams of values are required then one of the methods described in Section 2.1.1 in the G05 Chapter Introduction should be used.

However, for illustrative purposes only, this example calls g05kgf twice. At each call a sample of