NAG Library Routine Document
g05kjf (init_skipahead)
1
Purpose
g05kjf allows for the generation of multiple, independent, sequences of pseudorandom numbers using the skip-ahead method.
The base pseudorandom number sequence defined by
state is advanced
places.
2
Specification
Fortran Interface
Integer, Intent (In) | :: | n | Integer, Intent (Inout) | :: | state(*), ifail |
|
C Header Interface
#include <nagmk26.h>
void |
g05kjf_ (const Integer *n, Integer state[], Integer *ifail) |
|
3
Description
g05kjf adjusts a base generator to allow multiple, independent, sequences of pseudorandom numbers to be generated via the skip-ahead method (see the
G05 Chapter Introduction for details).
If, prior to calling
g05kjf the base generator defined by
state would produce random numbers
, then after calling
g05kjf the generator will produce random numbers
.
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
g05kjf.
The skip-ahead algorithm can be used in conjunction with any of the six base generators discussed in
Chapter G05.
4
References
Haramoto H, Matsumoto M, Nishimura T, Panneton F and L'Ecuyer P (2008) Efficient jump ahead for F2-linear random number generators INFORMS J. on Computing 20(3) 385–390
Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley
5
Arguments
- 1: – IntegerInput
-
On entry: , the number of places to skip ahead.
Constraint:
.
- 2: – 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.
- 3: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
On entry, .
Constraint: .
-
On entry,
state vector has been corrupted or not initialized.
-
On entry, cannot use skip-ahead with the base generator defined by
state.
-
On entry, the base generator is Mersenne Twister, but the
state vector defined on initialization is not large enough to perform a skip ahead. See the initialization routine
g05kff or
g05kgf.
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.
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.
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
Not applicable.
8
Parallelism and Performance
g05kjf is not threaded in any implementation.
Calling
g05kjf and then generating a series of uniform values using
g05saf is more efficient than, but equivalent to, calling
g05saf and discarding the first
values. This may not be the case for distributions other than the uniform, as some distributional generators require more than one uniform variate to generate a single draw from the required distribution.
To skip ahead
places you can either
(a) |
call g05kjf once with , or |
(b) |
call g05kjf times with , using the state vector output by the previous call as input to the next call |
both approaches would result in the same sequence of values. When working in a multithreaded environment, where you want to generate (at most)
values on each of
threads, this would translate into either
(a) |
spawning the threads and calling g05kjf once on each thread with , where is a thread ID, taking a value between and , or |
(b) |
calling g05kjf on a single thread with , spawning the threads and then calling g05kjf a further times on each of the thread. |
Due to the way skip ahead is implemented for the Mersenne Twister, approach
(a) will tend to be more efficient if more than 30 threads are being used (i.e.,
), otherwise approach
(b) should probably be used. For all other base generators, approach
(a) should be used. See the
G05 Chapter Introduction for more details.
10
Example
This example initializes a base generator using
g05kff and then uses
g05kjf to advance the sequence 50 places before generating five variates from a uniform distribution using
g05saf.
10.1
Program Text
Program Text (g05kjfe.f90)
10.2
Program Data
Program Data (g05kjfe.d)
10.3
Program Results
Program Results (g05kjfe.r)