NAG Library Routine Document

G05SNF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

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

1 Purpose

G05SNF generates a vector of pseudorandom numbers taken from a Student's

t

-distribution with

ν

degrees of freedom.

2 Specification

SUBROUTINE G05SNF (

N, DF, STATE, X, IFAIL)

INTEGER	N, DF, STATE(*), IFAIL
REAL (KIND=nag_wp)	X(N)

3 Description

The distribution has PDF (probability density function)

f (x) = \frac{(\frac{ν - 1}{2})!}{(\frac{1}{2} ν - 1)! \sqrt{π ν} {(1 + \frac{x^{2}}{ν})}^{\frac{1}{2} (ν + 1)}} .

G05SNF calculates the values

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

where the

y_{i}

are generated by G05SKF from a Normal distribution with mean

0

and variance

1.0

, and the

z_{i}

are generated by G05SJF from a gamma distribution with parameters

\frac{1}{2} ν

and

2

(i.e., from a

χ^{2}

-distribution with

ν

degrees of freedom).

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

4 References

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

5 Parameters

1: $N$ – INTEGERInput: On entry: $n$ , the number of pseudorandom numbers to be generated.

Constraint: $N \geq 0$ .
2: $DF$ – INTEGERInput: On entry: $ν$ , the number of degrees of freedom of the distribution.

Constraint: $DF \geq 1$ .
3: $STATE (*)$ – 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.
4: $X (N)$ – REAL (KIND=nag_wp) arrayOutput: On exit: the $n$ pseudorandom numbers from the specified Student's $t$ -distribution.
5: $IFAIL$ – INTEGERInput/Output: On entry: IFAIL must be set to $0$ , $- 1 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 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 $- 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, $DF = 〈value〉$ .
Constraint: $DF \geq 1$ .

$IFAIL = 3$: 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 3.8 in the Essential Introduction for further information.

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

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

G05SNF 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

The time taken by G05SNF increases with

ν

10 Example

This example prints five pseudorandom numbers from a Student's

t

-distribution with five degrees of freedom, generated by a single call to G05SNF, after initialization by G05KFF.

NAG Library Routine DocumentG05SNF