G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

NAG Library Routine DocumentG01EAF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

1  Purpose

G01EAF returns a one or two tail probability for the standard Normal distribution, via the routine name.

2  Specification

 FUNCTION G01EAF ( TAIL, X, IFAIL)
 REAL (KIND=nag_wp) G01EAF
 INTEGER IFAIL REAL (KIND=nag_wp) X CHARACTER(1) TAIL

3  Description

The lower tail probability for the standard Normal distribution, $P\left(X\le x\right)$ is defined by:
 $PX≤x=∫-∞xZXdX,$
where
 $ZX=12π e-X2/2, -∞
The relationship
 $PX≤x=12erfc-x2$
is used, where erfc is the complementary error function, and is computed using S15ADF. For the upper tail probability the relationship $P\left(X\ge x\right)=P\left(X\le -x\right)$ is used and for the two tail significance level probability twice the probability obtained from the absolute value of $x$ is returned.
When the two tail confidence probability is required the relationship
 $PX≤x-PX≤-x=erfx2 ,$
is used, where erf is the error function, and is computed using S15AEF.

4  References

Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Hastings N A J and Peacock J B (1975) Statistical Distributions Butterworth

5  Parameters

1:     TAIL – CHARACTER(1)Input
On entry: indicates which tail the returned probability should represent.
${\mathbf{TAIL}}=\text{'L'}$
The lower tail probability is returned, i.e., $P\left(X\le x\right)$.
${\mathbf{TAIL}}=\text{'U'}$
The upper tail probability is returned, i.e., $P\left(X\ge x\right)$.
${\mathbf{TAIL}}=\text{'S'}$
The two tail (significance level) probability is returned, i.e., $P\left(X\ge \left|x\right|\right)+P\left(X\le -\left|x\right|\right)$.
${\mathbf{TAIL}}=\text{'C'}$
The two tail (confidence interval) probability is returned, i.e., $P\left(X\le \left|x\right|\right)-P\left(X\le -\left|x\right|\right)$.
Constraint: ${\mathbf{TAIL}}=\text{'L'}$, $\text{'U'}$, $\text{'S'}$ or $\text{'C'}$.
2:     X – REAL (KIND=nag_wp)Input
On entry: $x$, the value of the standard Normal variate.
3:     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

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
If ${\mathbf{IFAIL}}\ne {\mathbf{0}}$, then G01EAF returns $0.0$.
${\mathbf{IFAIL}}=1$
 On entry, ${\mathbf{TAIL}}\ne \text{'L'}$, $\text{'U'}$, $\text{'S'}$ or $\text{'C'}$.

7  Accuracy

Accuracy is limited by machine precision. For detailed error analysis see S15ADF and S15AEF.

None.

9  Example

Four values of TAIL and X are input and the probabilities calculated and printed.

9.1  Program Text

Program Text (g01eafe.f90)

9.2  Program Data

Program Data (g01eafe.d)

9.3  Program Results

Program Results (g01eafe.r)