NAG Library Routine Document
g01taf
(inv_cdf_normal_vector)
1
Purpose
g01taf returns a number of deviates associated with given probabilities of the Normal distribution.
2
Specification
Fortran Interface
Subroutine g01taf ( |
ltail,
tail,
lp,
p,
lxmu,
xmu,
lxstd,
xstd,
x,
ivalid,
ifail) |
Integer, Intent (In) | :: |
ltail,
lp,
lxmu,
lxstd | Integer, Intent (Inout) | :: |
ifail | Integer, Intent (Out) | :: |
ivalid(*) | Real (Kind=nag_wp), Intent (In) | :: |
p(lp),
xmu(lxmu),
xstd(lxstd) | Real (Kind=nag_wp), Intent (Out) | :: |
x(*) | Character (1), Intent (In) | :: |
tail(ltail) |
|
C Header Interface
#include nagmk26.h
void |
g01taf_ (
const Integer *ltail,
const char tail[],
const Integer *lp,
const double p[],
const Integer *lxmu,
const double xmu[],
const Integer *lxstd,
const double xstd[],
double x[],
Integer ivalid[],
Integer *ifail,
const Charlen length_tail) |
|
3
Description
The deviate,
associated with the lower tail probability,
, for the Normal distribution is defined as the solution to
where
The method used is an extension of that of
Wichura (1988).
is first replaced by
.
(a) |
If , is computed by a rational Chebyshev approximation
where and , are polynomials of degree . |
(b) |
If , is computed by a rational Chebyshev approximation
where and , are polynomials of degree . |
(c) |
If , is computed as
where and , are polynomials of degree . |
is then calculated from , using the relationsship .
For the upper tail probability is returned, while for the two tail probabilities the value is returned, where is the required tail probability computed from the input value of .
The input arrays to this routine are designed to allow maximum flexibility in the supply of vector arguments 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
Arguments
- 1: – IntegerInput
-
On entry: the length of the array
tail.
Constraint:
.
- 2: – Character(1) arrayInput
-
On entry: indicates which tail the supplied probabilities represent. Letting
denote a variate from a standard Normal distribution, and
, then for
, for
:
- The lower tail probability, i.e., .
- The upper tail probability, i.e., .
- The two tail (confidence interval) probability, i.e., .
- The two tail (significance level) probability, i.e., .
Constraint:
, , or , for .
- 3: – IntegerInput
-
On entry: the length of the array
p.
Constraint:
.
- 4: – Real (Kind=nag_wp) arrayInput
-
On entry:
, the probabilities for the Normal distribution as defined by
tail with
,
.
Constraint:
, for .
- 5: – IntegerInput
-
On entry: the length of the array
xmu.
Constraint:
.
- 6: – Real (Kind=nag_wp) arrayInput
-
On entry: , the means with , .
- 7: – IntegerInput
-
On entry: the length of the array
xstd.
Constraint:
.
- 8: – Real (Kind=nag_wp) arrayInput
-
On entry: , the standard deviations with , .
Constraint:
, for .
- 9: – Real (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
x
must be at least
.
On exit: , the deviates for the Normal distribution.
- 10: – Integer arrayOutput
-
Note: the dimension of the array
ivalid
must be at least
.
On exit:
indicates any errors with the input arguments, with
- No error.
-
On entry, | invalid value supplied in tail when calculating . |
-
On entry, | , |
or | . |
-
- 11: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
On entry, at least one value of
tail,
xstd or
p was invalid.
Check
ivalid for more information.
-
On entry, .
Constraint: .
-
On entry, .
Constraint: .
-
On entry, .
Constraint: .
-
On entry, .
Constraint: .
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.
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.
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
The accuracy is mainly limited by the machine precision.
8
Parallelism and Performance
g01taf is not threaded in any implementation.
None.
10
Example
This example reads vectors of values for , and 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)