Integer, Intent (In)	::	n, nmix
Integer, Intent (Inout)	::	state(*), ifail
Real (Kind=nag_wp), Intent (In)	::	a(nmix), wgt(nmix)
Real (Kind=nag_wp), Intent (Out)	::	x(n)

C Header Interface

#include <nag.h>

void	g05sgf_ (const Integer n, const Integer nmix, const double a[], const double wgt[], Integer state[], double x[], Integer *ifail)

The routine may be called by the names g05sgf or nagf_rand_dist_expmix.

3 Description

The distribution has PDF (probability density function)

\begin{array}{l} f (x) = \sum_{i = 1}^{m} \frac{1}{a_{i}} w_{i} e^{- x / a_{i}} & if ​ x \geq 0, \\ f (x) = 0 & otherwise, \end{array}

where

\sum_{i = 1}^{m} w_{i} = 1

and

a_{i} > 0

w_{i} \geq 0

g05sgf returns the values

x_{i}

by selecting, with probability

w_{j}

, random variates from an exponential distribution with parameter

a_{j}

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

4 References

Kendall M G and Stuart A (1969) The Advanced Theory of Statistics (Volume 1) (3rd Edition) Griffin

Knuth D E (1981) The Art of Computer Programming (Volume 2) (2nd Edition) Addison–Wesley

5 Arguments

1: $n$ – Integer Input

On entry:

n

, the number of pseudorandom numbers to be generated.

Constraint:

n \geq 0

2: $nmix$ – Integer Input

On entry:

m

, the number of exponential distributions in the mix.

Constraint:

nmix \geq 1

3: $a (nmix)$ – Real (Kind=nag_wp) array Input

On entry: the

m

parameters

a_{i}

for the

m

exponential distributions in the mix.

Constraint:

a (i) > 0.0

, for

i = 1, 2, \dots, nmix

4: $wgt (nmix)$ – Real (Kind=nag_wp) array Input

On entry: the

m

weights

w_{i}

for the

m

exponential distributions in the mix.

Constraints:

$\sum_{i = 1}^{m} wgt (i) = 1.0$ ;
$wgt (i) \geq 0.0$ , for $i = 1, 2, \dots, m$ .

5: $state (*)$ – Integer array Communication 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.

6: $x (n)$ – Real (Kind=nag_wp) array Output

On exit: the

n

pseudorandom numbers from the specified exponential mix distribution.

7: $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, $n = ⟨ value ⟩$ .
Constraint: $n \geq 0$ .

$ifail = 2$: On entry, $nmix = ⟨ value ⟩$ .
Constraint: $nmix \geq 1$ .

$ifail = 3$: On entry, $a (⟨ value ⟩) = ⟨ value ⟩$ .
Constraint: $a (i) > 0.0$ .

$ifail = 4$: On entry, sum of $wgt = ⟨ value ⟩$ .
Constraint: sum of $wgt = 1.0$ .

On entry, $wgt (⟨ value ⟩) = ⟨ value ⟩$ .
Constraint: $wgt (i) \geq 0.0$ .

$ifail = 5$: On entry, state vector has been corrupted or 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.

g05sgf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

None.

10 Example

This example prints the first five pseudorandom numbers from an exponential mix distribution comprising three exponential distributions with parameters

a_{1} = 1.0

a_{2} = 5.0

and

a_{3} = 2.0

, and with respective weights

0.5

0.3

and

0.2

. The numbers are generated by a single call to g05sgf, after initialization by g05kff.

g05sg: FL CL CPP AD PY MB

NAG FL Interfaceg05sgf (dist_​expmix)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
g05sgf (dist_expmix)