G01 Chapter Contents
G01 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentG01TAF

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

G01TAF returns a number of deviates associated with given probabilities of the Normal distribution.

## 2  Specification

 SUBROUTINE G01TAF ( LTAIL, TAIL, LP, P, LXMU, XMU, LXSTD, XSTD, X, IVALID, IFAIL)
 INTEGER LTAIL, LP, LXMU, LXSTD, IVALID(*), IFAIL REAL (KIND=nag_wp) P(LP), XMU(LXMU), XSTD(LXSTD), X(*) CHARACTER(1) TAIL(LTAIL)

## 3  Description

The deviate, ${x}_{{p}_{i}}$ associated with the lower tail probability, ${p}_{i}$, for the Normal distribution is defined as the solution to
 $PXi≤xpi=pi=∫-∞xpiZiXidXi,$
where
 $ZiXi=12πσi2e-Xi-μi2/2σi2, ​-∞
The method used is an extension of that of Wichura (1988). ${p}_{i}$ is first replaced by ${q}_{i}={p}_{i}-0.5$.
(a) If $\left|{q}_{i}\right|\le 0.3$, ${z}_{i}$ is computed by a rational Chebyshev approximation
 $zi=siAisi2 Bisi2 ,$
where ${s}_{i}=\sqrt{2\pi }{q}_{i}$ and ${A}_{i}$, ${B}_{i}$ are polynomials of degree $7$.
(b) If $0.3<\left|{q}_{i}\right|\le 0.42$, ${z}_{i}$ is computed by a rational Chebyshev approximation
 $zi=sign⁡qi Citi Diti ,$
where ${t}_{i}=\left|{q}_{i}\right|-0.3$ and ${C}_{i}$, ${D}_{i}$ are polynomials of degree $5$.
(c) If $\left|{q}_{i}\right|>0.42$, ${z}_{i}$ is computed as
 $zi=sign⁡qi Eiui Fiui +ui ,$
where ${u}_{i}=\sqrt{-2×\mathrm{log}\left(\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left({p}_{i},1-{p}_{i}\right)\right)}$ and ${E}_{i}$, ${F}_{i}$ are polynomials of degree $6$.
${x}_{{p}_{i}}$ is then calculated from ${z}_{i}$, using the relationsship ${z}_{{p}_{i}}=\frac{{x}_{i}-{\mu }_{i}}{{\sigma }_{i}}$.
For the upper tail probability $-{x}_{{p}_{i}}$ is returned, while for the two tail probabilities the value ${x}_{i{{p}_{i}}^{*}}$ is returned, where ${{p}_{i}}^{*}$ is the required tail probability computed from the input value of ${p}_{i}$.
The input arrays to this routine are designed to allow maximum flexibility in the supply of vector parameters by re-using elements of any arrays that are shorter than the total number of evaluations required. See Section 2.6 in the G01 Chapter Introduction for further information.

## 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
Wichura (1988) Algorithm AS 241: the percentage points of the Normal distribution Appl. Statist. 37 477–484

## 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. Letting $Z$ denote a variate from a standard Normal distribution, and ${z}_{i}=\frac{{x}_{{p}_{i}}-{\mu }_{i}}{{\sigma }_{i}}$, then for , for $\mathit{i}=1,2,\dots ,\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{LTAIL}},{\mathbf{LP}},{\mathbf{LXMU}},{\mathbf{LXSTD}}\right)$:
${\mathbf{TAIL}}\left(j\right)=\text{'L'}$
The lower tail probability, i.e., ${p}_{i}=P\left(Z\le {z}_{i}\right)$.
${\mathbf{TAIL}}\left(j\right)=\text{'U'}$
The upper tail probability, i.e., ${p}_{i}=P\left(Z\ge {z}_{i}\right)$.
${\mathbf{TAIL}}\left(j\right)=\text{'C'}$
The two tail (confidence interval) probability, i.e., ${p}_{i}=P\left(Z\le \left|{z}_{i}\right|\right)-P\left(Z\le -\left|{z}_{i}\right|\right)$.
${\mathbf{TAIL}}\left(j\right)=\text{'S'}$
The two tail (significance level) probability, i.e., ${p}_{i}=P\left(Z\ge \left|{z}_{i}\right|\right)+P\left(Z\le -\left|{z}_{i}\right|\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 probabilities for the Normal distribution as defined by TAIL with ${p}_{i}={\mathbf{P}}\left(j\right)$, .
Constraint: $0.0<{\mathbf{P}}\left(\mathit{j}\right)<1.0$, for $\mathit{j}=1,2,\dots ,{\mathbf{LP}}$.
5:     $\mathrm{LXMU}$ – INTEGERInput
On entry: the length of the array XMU.
Constraint: ${\mathbf{LXMU}}>0$.
6:     $\mathrm{XMU}\left({\mathbf{LXMU}}\right)$ – REAL (KIND=nag_wp) arrayInput
On entry: ${\mu }_{i}$, the means with ${\mu }_{i}={\mathbf{XMU}}\left(j\right)$, .
7:     $\mathrm{LXSTD}$ – INTEGERInput
On entry: the length of the array XSTD.
Constraint: ${\mathbf{LXSTD}}>0$.
8:     $\mathrm{XSTD}\left({\mathbf{LXSTD}}\right)$ – REAL (KIND=nag_wp) arrayInput
On entry: ${\sigma }_{i}$, the standard deviations with ${\sigma }_{i}={\mathbf{XSTD}}\left(j\right)$, .
Constraint: ${\mathbf{XSTD}}\left(\mathit{j}\right)>0.0$, for $\mathit{j}=1,2,\dots ,{\mathbf{LXSTD}}$.
9:     $\mathrm{X}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput
Note: the dimension of the array X must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{LTAIL}},{\mathbf{LXMU}},{\mathbf{LXSTD}},{\mathbf{LP}}\right)$.
On exit: ${x}_{{p}_{i}}$, the deviates for the Normal distribution.
10:   $\mathrm{IVALID}\left(*\right)$ – INTEGER arrayOutput
Note: the dimension of the array IVALID must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{LTAIL}},{\mathbf{LXMU}},{\mathbf{LXSTD}},{\mathbf{LP}}\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 ${x}_{{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, ${\sigma }_{i}\le 0.0$.
11:   $\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

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:
${\mathbf{IFAIL}}=1$
On entry, at least one value of TAIL, XSTD or P was invalid.
${\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{LXMU}}>0$.
${\mathbf{IFAIL}}=5$
On entry, $\text{array size}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{LXSTD}}>0$.
${\mathbf{IFAIL}}=-99$
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

The accuracy is mainly limited by the machine precision.

Not applicable.

None.

## 10  Example

This example reads vectors of values for ${\mu }_{i}$, ${\sigma }_{i}$ and ${p}_{i}$ and prints the corresponding deviates.

### 10.1  Program Text

Program Text (g01tafe.f90)

### 10.2  Program Data

Program Data (g01tafe.d)

### 10.3  Program Results

Program Results (g01tafe.r)