NAG Library Function Document

nag_rand_cauchy (g05scc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:     n – IntegerInput

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

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

2:     xmed – doubleInput

On entry: $a$, the median of the distribution.

3:     semiqr – doubleInput

On entry: $b$, the semi-interquartile range of the distribution.

Constraint: $\mathbf{semiqr}\ge 0.0$.

4:     state[$\mathit{dim}$] – IntegerCommunication Array

Note: the dimension, $\mathit{dim}$, of this array is dictated by the requirements of associated functions that must have been previously called. This array MUST be the same array passed as argument state in the previous call to nag_rand_init_repeatable (g05kfc) or nag_rand_init_nonrepeatable (g05kgc).

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:     x[n] – doubleOutput

On exit: the $n$ pseudorandom numbers from the specified Cauchy distribution.

6:     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 $⟨\mathit{\text{value}}⟩$ had an illegal value.

NE_INT

On entry, $\mathbf{n}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{n}\ge 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.

NE_INVALID_STATE

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

NE_REAL

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

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (g05scce.c)

10.2  Program Data

10.3  Program Results

Program Results (g05scce.r)