NAG CL Interface
g05ypc (quasi_​uniform_​bydim)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{order}$ – 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 $\mathbf{order}=\mathrm{Nag\_RowMajor}$. 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: $\mathbf{order}=\mathrm{Nag\_RowMajor}$ or $\mathrm{Nag\_ColMajor}$.

2: $\mathbf{n}$ – Integer Input

On entry: the number of quasi-random numbers required.

Constraint: $\mathbf{n}\ge 0$ and $\mathbf{n}+\text{previous number of generated values}\le 2^{31}-1$.

3: $\mathbf{fdim}$ – Integer Input

On entry: the first dimension to return.

Constraint: $1\le \mathbf{fdim}\le \mathbf{ldim}$.

4: $\mathbf{ldim}$ – Integer Input

On entry: the last dimension to return.

Constraint: $\mathbf{ldim}\le \mathit{idim}$.

5: $\mathbf{quas}\left[\mathit{dim}\right]$ – double Output

Note: where $\mathbf{QUAS}(i,k)$ appears in this document, it refers to the array element

• $\mathbf{quas}\left[(k-1)\times \mathbf{pdquas}+i-1\right]$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\mathbf{quas}\left[(i-1)\times \mathbf{pdquas}+k-1\right]$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

On exit: contains the n quasi-random numbers for the required dimensions of a sequence with idim dimensions.

For $i=1,2,\dots ,\mathbf{n}$, $j=\mathbf{fdim},\mathbf{fdim}+1,\dots ,\mathbf{ldim}$ the $\mathit{i}$th value for the $\mathit{j}$th dimension is held in $\mathbf{QUAS}(\mathit{i},k)$, where $k=\mathit{j}-\mathbf{fdim}+1$.

6: $\mathbf{pdquas}$ – Integer Input

On entry: the stride separating row or column elements (depending on the value of order) in the array quas.

Constraints:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$, $\mathbf{pdquas}\ge \mathbf{n}$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$, $\mathbf{pdquas}\ge \mathbf{ldim}-\mathbf{fdim}+1$.

7: $\mathbf{iref}\left[\mathit{dim}\right]$ – Integer Communication Array

Note: the dimension, dim, of the array iref must be at least $\mathit{liref}$.

On entry: contains information on the current state of the sequence.

On exit: contains updated information on the state of the sequence.

8: $\mathbf{fail}$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

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, $\mathbf{pdquas}=⟨\mathit{\text{value}}⟩$ and $\mathbf{ldim}-\mathbf{fdim}+1=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdquas}\ge \mathbf{ldim}-\mathbf{fdim}+1$.

On entry, $\mathbf{pdquas}=⟨\mathit{\text{value}}⟩$ and $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{pdquas}\ge \mathbf{n}$.

NE_BAD_PARAM

On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.

NE_INITIALIZATION

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

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, $\mathbf{ldim}=⟨\mathit{\text{value}}⟩$ and $\mathit{idim}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{ldim}\le \mathit{idim}$

On entry, $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{n}\ge 0$.

NE_INT_2

On entry, $\mathbf{fdim}=⟨\mathit{\text{value}}⟩$ and $\mathbf{ldim}=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le \mathbf{fdim}\le \mathbf{ldim}$

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_TOO_MANY_CALLS

On entry, value of n would result in too many calls to the generator: $\mathbf{n}=⟨\mathit{\text{value}}⟩$, generator has previously been called $⟨\mathit{\text{value}}⟩$ times.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results