NAG Library Function Document

nag_rngs_f (g05ldc)

+− Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Further Comments

+− 9 Example

9.1 Program Text

9.2 Program Data

9.3 Program Results

1 Purpose

nag_rngs_f (g05ldc) generates a vector of pseudorandom numbers taken from an

F

(or Fisher's variance ratio) distribution with

μ

and

ν

degrees of freedom.

2 Specification

#include <nag.h>

#include <nagg05.h>

void	nag_rngs_f (Integer df1, Integer df2, Integer n, double x[], Integer igen, Integer iseed[], NagError *fail)

3 Description

The distribution has PDF (probability density function)

\begin{array}{l} f (x) = \frac{(\frac{μ + ν - 2}{2})! x^{\frac{1}{2} μ - 1}}{(\frac{1}{2} μ - 1)! (\frac{1}{2} ν - 1)! {(1 + \frac{μ}{ν} x)}^{\frac{1}{2} (μ + ν)}} \times {(\frac{μ}{ν})}^{\frac{1}{2} μ} & if ​ x > 0, \\ f (x) = 0 & otherwise. \end{array}

nag_rngs_f (g05ldc) calculates the values

\frac{ν y_{i}}{μ z_{i}}, i = 1, \dots, n,

where

y_{i}

and

z_{i}

are generated by nag_rngs_gamma (g05lfc) from gamma distributions with parameters

(\frac{1}{2} μ, 2)

and

(\frac{1}{2} ν, 2)

respectively (i.e., from

χ^{2}

-distributions with

μ

and

ν

degrees of freedom).

One of the initialization functions nag_rngs_init_repeatable (g05kbc) (for a repeatable sequence if computed sequentially) or nag_rngs_init_nonrepeatable (g05kcc) (for a non-repeatable sequence) must be called prior to the first call to nag_rngs_f (g05ldc).

4 References

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

5 Arguments

1: df1 – IntegerInput: On entry: $μ$ , the number of degrees of freedom of the distribution.
Constraint: $df1 \geq 1$ .
2: df2 – IntegerInput: On entry: $ν$ , the number of degrees of freedom of the distribution.
Constraint: $df2 \geq 1$ .
3: n – IntegerInput: On entry: $n$ , the number of pseudorandom numbers to be generated.
Constraint: $n \geq 0$ .
4: x[n] – doubleOutput: On exit: the $n$ pseudorandom numbers from the specified $F$ -distribution.
5: igen – IntegerInput: On entry: must contain the identification number for the generator to be used to return a pseudorandom number and should remain unchanged following initialization by a prior call to nag_rngs_init_repeatable (g05kbc) or nag_rngs_init_nonrepeatable (g05kcc).
6: iseed[ $4$ ] – IntegerCommunication Array: On entry: contains values which define the current state of the selected generator.
On exit: contains updated values defining the new state of the selected generator.
7: fail – NagError *Input/Output: The NAG error argument (see Section 3.6 in the Essential Introduction).

6 Error Indicators and Warnings

NE_BAD_PARAM: On entry, argument $〈value〉$ had an illegal value.
NE_INT: On entry, $df1 = 〈value〉$ .
Constraint: $df1 \geq 1$ .; On entry, $df2 = 〈value〉$ .
Constraint: $df2 \geq 1$ .; On entry, $n = 〈value〉$ .
Constraint: $n \geq 0$ .
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.

7 Accuracy

Not applicable.

8 Further Comments

The time taken by nag_rngs_f (g05ldc) increases with

μ

and

ν

9 Example

This example prints five pseudorandom numbers from an

F

-distribution with two and three degrees of freedom, generated by a single call to nag_rngs_f (g05ldc), after initialization by nag_rngs_init_repeatable (g05kbc).