NAG Library Routine Document

g01ebf  (prob_students_t)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{tail}$ – Character(1)Input

On entry: indicates which tail the returned probability should represent.

$\mathbf{tail}=\text{'U'}$

The upper tail probability is returned, i.e., $P\left(T\ge t:\nu \right)$.

$\mathbf{tail}=\text{'S'}$

The two tail (significance level) probability is returned, i.e., $P\left(T\ge \left|t\right|:\nu \right)+P\left(T\le -\left|t\right|:\nu \right)$.

$\mathbf{tail}=\text{'C'}$

The two tail (confidence interval) probability is returned, i.e., $P\left(T\le \left|t\right|:\nu \right)-P\left(T\le -\left|t\right|:\nu \right)$.

$\mathbf{tail}=\text{'L'}$

The lower tail probability is returned, i.e., $P\left(T\le t:\nu \right)$.

Constraint: $\mathbf{tail}=\text{'U'}$, $\text{'S'}$, $\text{'C'}$ or $\text{'L'}$.

2:     $\mathbf{t}$ – Real (Kind=nag_wp)Input

On entry: $t$, the value of the Student's $t$ variate.

3:     $\mathbf{df}$ – Real (Kind=nag_wp)Input

On entry: $\nu$, the degrees of freedom of the Student's $t$-distribution.

Constraint: $\mathbf{df}\ge 1.0$.

4:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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, $\mathbf{tail}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{tail}=\text{'L'}$, $\text{'U'}$, $\text{'S'}$ or $\text{'C'}$.

$\mathbf{ifail}=2$

On entry, $\mathbf{df}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{df}\ge 1.0$.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (g01ebfe.f90)

10.2

Program Data

Program Data (g01ebfe.d)

10.3

Program Results

Program Results (g01ebfe.r)