NAG Library Routine Document

G01TBF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{LTAIL}$ – INTEGERInput

On entry: the length of the array TAIL.

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

2:     $\mathrm{TAIL}\left(\mathbf{LTAIL}\right)$ – CHARACTER(1) arrayInput

On entry: indicates which tail the supplied probabilities represent. For $j=\left(\left(\mathit{i}-1\right)\mathrm{ mod }\mathbf{LTAIL}\right)+1$, for $\mathit{i}=1,2,\dots ,\max \left(\mathbf{LTAIL},\mathbf{LP},\mathbf{LDF}\right)$:

$\mathbf{TAIL}\left(j\right)=\text{'L'}$

The lower tail probability, i.e., $p_i=P\left(T_i\le t_{p_i}:{\nu }_i\right)$.

$\mathbf{TAIL}\left(j\right)=\text{'U'}$

The upper tail probability, i.e., $p_i=P\left(T_i\ge t_{p_i}:{\nu }_i\right)$.

$\mathbf{TAIL}\left(j\right)=\text{'C'}$

The two tail (confidence interval) probability,
i.e., $p_i=P\left(T_i\le \left|t_{p_i}\right|:{\nu }_i\right)-P\left(T_i\le -\left|t_{p_i}\right|:{\nu }_i\right)$.

$\mathbf{TAIL}\left(j\right)=\text{'S'}$

The two tail (significance level) probability,
i.e., $p_i=P\left(T_i\ge \left|t_{p_i}\right|:{\nu }_i\right)+P\left(T_i\le -\left|t_{p_i}\right|:{\nu }_i\right)$.

Constraint: $\mathbf{TAIL}\left(\mathit{j}\right)=\text{'L'}$, $\text{'U'}$, $\text{'C'}$ or $\text{'S'}$, for $\mathit{j}=1,2,\dots ,\mathbf{LTAIL}$.

3:     $\mathrm{LP}$ – INTEGERInput

On entry: the length of the array P.

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

4:     $\mathrm{P}\left(\mathbf{LP}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: $p_i$, the probability of the required Student's $t$-distribution as defined by TAIL with $p_i=\mathbf{P}\left(j\right)$, $j=\left(\left(i-1\right)\mathrm{ mod }\mathbf{LP}\right)+1$.

Constraint: $0.0<\mathbf{P}\left(\mathit{j}\right)<1.0$, for $\mathit{j}=1,2,\dots ,\mathbf{LP}$.

5:     $\mathrm{LDF}$ – INTEGERInput

On entry: the length of the array DF.

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

6:     $\mathrm{DF}\left(\mathbf{LDF}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: ${\nu }_i$, the degrees of freedom of the Student's $t$-distribution with ${\nu }_i=\mathbf{DF}\left(j\right)$, $j=\left(\left(i-1\right)\mathrm{ mod }\mathbf{LDF}\right)+1$.

Constraint: $\mathbf{DF}\left(\mathit{j}\right)\ge 1.0$, for $\mathit{j}=1,2,\dots ,\mathbf{LDF}$.

7:     $\mathrm{T}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput

Note: the dimension of the array T must be at least $\max \left(\mathbf{LTAIL},\mathbf{LP},\mathbf{LDF}\right)$.

On exit: $t_{p_i}$, the deviates for the Student's $t$-distribution.

8:     $\mathrm{IVALID}\left(*\right)$ – INTEGER arrayOutput

Note: the dimension of the array IVALID must be at least $\max \left(\mathbf{LTAIL},\mathbf{LP},\mathbf{LDF}\right)$.

On exit: $\mathbf{IVALID}\left(i\right)$ indicates any errors with the input arguments, with

$\mathbf{IVALID}\left(i\right)=0$

No error.

$\mathbf{IVALID}\left(i\right)=1$

On entry,

invalid value supplied in TAIL when calculating $t_{p_i}$.

$\mathbf{IVALID}\left(i\right)=2$

On entry,	$p_i\le 0.0$,
or	$p_i\ge 1.0$.

$\mathbf{IVALID}\left(i\right)=3$

On entry,

${\nu }_i<1.0$.

$\mathbf{IVALID}\left(i\right)=4$

The solution has failed to converge. The result returned should represent an approximation to the solution.

9:     $\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, at least one value of TAIL, P or DF was invalid, or the solution failed to converge.
Check IVALID for more information.

$\mathbf{IFAIL}=2$

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

$\mathbf{IFAIL}=3$

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

$\mathbf{IFAIL}=4$

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

$\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 (g01tbfe.f90)

10.2  Program Data

Program Data (g01tbfe.d)

10.3  Program Results

Program Results (g01tbfe.r)