g05yrc generates a quasi-random sequence from a log-normal distribution. It must be preceded by a call to one of the initialization functions
g05ylc or
g05ync.
g05yrc generates a quasi-random sequence, for a specified subset of dimensions, from a log-normal distribution by first generating a uniform quasi-random sequence, for the specified subset of dimensions, which is then transformed into a log-normal sequence using the exponential of the inverse of the Normal CDF. The type of uniform sequence used depends on the initialization function called and can include the low-discrepancy sequences proposed by Sobol, Faure or Niederreiter. If the initialization function
g05ync was used then the underlying uniform sequence is first scrambled prior to being transformed (see
Section 3 in
g05ync for details).
Bratley P and Fox B L (1988) Algorithm 659: implementing Sobol's quasirandom sequence generator ACM Trans. Math. Software 14(1) 88–100
Fox B L (1986) Algorithm 647: implementation and relative efficiency of quasirandom sequence generators ACM Trans. Math. Software 12(4) 362–376
Wichura (1988) Algorithm AS 241: the percentage points of the Normal distribution Appl. Statist. 37 477–484
Note: the following variables are used in the parameter descriptions:
- , the number of dimensions required, see g05ylc or g05ync;
- , the length of iref as supplied to the initialization functions g05ylc or g05ync.
-
1:
– Nag_OrderType
Input
-
On entry: the
order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by
. See
Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
Constraint:
or .
-
2:
– Integer
Input
-
On entry: the number of quasi-random numbers required.
Constraint:
and .
-
3:
– const double
Input
-
On entry: specifies, for each dimension, the mean of the underlying Normal distribution.
Constraint:
, for .
-
4:
– const double
Input
-
On entry: specifies, for each dimension, the standard deviation of the underlying Normal distribution.
Constraint:
, for .
-
5:
– Integer
Input
-
On entry: the first dimension to return.
Constraint:
.
-
6:
– Integer
Input
-
On entry: the last dimension to return.
Constraint:
.
-
7:
– double
Output
-
Note: where
appears in this document, it refers to the array element
- when ;
- when .
On exit: contains the
n quasi-random numbers for the required dimensions of a sequence with
idim dimensions.
For
,
and
, the
th value for the
th dimension is held in
- , if ,
- , if .
-
8:
– Integer
Input
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
quas.
Constraints:
- if , ;
- if , .
-
9:
– Integer
Communication Array
Note: the dimension,
dim, of the array
iref
must be at least
.
On entry: contains information on the current state of the sequence.
On exit: contains updated information on the state of the sequence.
-
10:
– NagError *
Input/Output
-
The NAG error argument (see
Section 7 in the Introduction to the NAG Library CL Interface).
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
- NE_ARRAY_SIZE
-
On entry, and .
Constraint: .
On entry, and .
Constraint: .
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_INITIALIZATION
-
g05yrc can not be used with the Faure generator.
On entry,
iref has either not been initialized or has been corrupted.
On entry,
iref is too short to use with
g05yrc.
On entry, the specified dimensions are out of sync.
A different number of values have been generated from at least one of the specified dimensions.
- NE_INT
-
On entry, and .
Constraint:
On entry, .
Constraint: .
- NE_INT_2
-
On entry, and .
Constraint:
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
See
Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 8 in the Introduction to the NAG Library CL Interface for further information.
- NE_REAL_ARRAY
-
On entry, and .
Constraint: .
On entry, and .
Constraint: .
- NE_TOO_MANY_CALLS
-
On entry, value of
n would result in too many calls to the generator:
, generator has previously been called
times.
Not applicable.
Background information to multithreading can be found in the
Multithreading documentation.
Please consult the
X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
None.