NAG Library Routine Document

G05SEF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{N}$ – INTEGERInput

On entry: $n$, the number of pseudorandom numbers to be generated.

Constraint: $\mathbf{N}\ge 0$.

2:     $\mathrm{M}$ – INTEGERInput

On entry: $m$, the number of dimensions of the distribution.

Constraint: $\mathbf{M}>0$.

3:     $\mathrm{A}\left(\mathbf{M}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: the parameter vector for the distribution.

Constraint: $\mathbf{A}\left(\mathit{i}\right)>0.0$, for $\mathit{i}=1,2,\dots ,\mathbf{M}$.

4:     $\mathrm{STATE}\left(*\right)$ – 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.

5:     $\mathrm{X}\left(\mathbf{LDX},\mathbf{M}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: the $n$ pseudorandom numbers from the specified Dirichlet distribution, with $\mathbf{X}\left(i,j\right)$ holding the $j$th dimension for the $i$th variate.

6:     $\mathrm{LDX}$ – INTEGERInput

On entry: the first dimension of the array X as declared in the (sub)program from which G05SEF is called.

Constraint: $\mathbf{LDX}\ge \mathbf{N}$.

7:     $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.

On exit: $\mathbf{IFAIL}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

$\mathbf{IFAIL}=1$

On entry, $\mathbf{N}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{N}\ge 0$.

$\mathbf{IFAIL}=2$

On entry, $\mathbf{M}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{M}>0$.

$\mathbf{IFAIL}=3$

On entry, at least one $\mathbf{A}\left(i\right)\le 0$.

$\mathbf{IFAIL}=4$

On entry, STATE vector has been corrupted or not initialized.

$\mathbf{IFAIL}=6$

On entry, $\mathbf{LDX}=〈\mathit{\text{value}}〉$ and $\mathbf{N}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{LDX}\ge \mathbf{N}$.

$\mathbf{IFAIL}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (g05sefe.f90)

10.2  Program Data

Program Data (g05sefe.d)

10.3  Program Results

Program Results (g05sefe.r)