PDF version (NAG web site
, 64-bit version, 64-bit version)
NAG Toolbox: nag_stat_inv_cdf_gamma_vector (g01tf)
Purpose
nag_stat_inv_cdf_gamma_vector (g01tf) returns a number of deviates associated with given probabilities of the gamma distribution.
Syntax
[
g,
ivalid,
ifail] = g01tf(
tail,
p,
a,
b, 'ltail',
ltail, 'lp',
lp, 'la',
la, 'lb',
lb, 'tol',
tol)
[
g,
ivalid,
ifail] = nag_stat_inv_cdf_gamma_vector(
tail,
p,
a,
b, 'ltail',
ltail, 'lp',
lp, 'la',
la, 'lb',
lb, 'tol',
tol)
Description
The deviate,
, associated with the lower tail probability,
, of the gamma distribution with shape parameter
and scale parameter
, is defined as the solution to
The method used is described by
Best and Roberts (1975) making use of the relationship between the gamma distribution and the
-distribution.
Let
. The required
is found from the Taylor series expansion
where
is a starting approximation
- ,
- ,
- ,
- ,
- .
For most values of
and
the starting value
is used, where
is the deviate associated with a lower tail probability of
for the standard Normal distribution.
For
close to zero,
is used.
For large
values, when
,
is found to be a better starting value than
.
For small , is expressed in terms of an approximation to the exponential integral and is found by Newton–Raphson iterations.
Seven terms of the Taylor series are used to refine the starting approximation, repeating the process if necessary until the required accuracy is obtained.
The input arrays to this function 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
Vectorized Routines in the G01 Chapter Introduction for further information.
References
Best D J and Roberts D E (1975) Algorithm AS 91. The percentage points of the distribution Appl. Statist. 24 385–388
Parameters
Compulsory Input Parameters
- 1:
– cell array of strings
-
Indicates which tail the supplied probabilities represent. For
, for
:
- The lower tail probability, i.e., .
- The upper tail probability, i.e., .
Constraint:
or , for .
- 2:
– double array
-
, the probability of the required gamma distribution as defined by
tail with
,
.
Constraints:
- if , ;
- otherwise .
Where and .
- 3:
– double array
-
, the first parameter of the required gamma distribution with , .
Constraint:
, for .
- 4:
– double array
-
, the second parameter of the required gamma distribution with , .
Constraint:
, for .
Optional Input Parameters
- 1:
– int64int32nag_int scalar
-
Default:
the dimension of the array
tail.
The length of the array
tail.
Constraint:
.
- 2:
– int64int32nag_int scalar
-
Default:
the dimension of the array
p.
The length of the array
p.
Constraint:
.
- 3:
– int64int32nag_int scalar
-
Default:
the dimension of the array
a.
The length of the array
a.
Constraint:
.
- 4:
– int64int32nag_int scalar
-
Default:
the dimension of the array
b.
The length of the array
b.
Constraint:
.
- 5:
– double scalar
Default:
The relative accuracy required by you in the results. If
nag_stat_inv_cdf_gamma_vector (g01tf) is entered with
tol greater than or equal to
or less than
(see
nag_machine_precision (x02aj)), then the value of
is used instead.
Output Parameters
- 1:
– double array
-
The dimension of the array
g will be
, the deviates for the gamma distribution.
- 2:
– int64int32nag_int array
-
The dimension of the array
ivalid will be
indicates any errors with the input arguments, with
- No error.
On entry, | invalid value supplied in tail when calculating . |
On entry, | invalid value for . |
On entry, | , |
or | , |
or | . |
- is too close to or to enable the result to be calculated.
- The solution has failed to converge. The result may be a reasonable approximation.
- 3:
– int64int32nag_int scalar
unless the function detects an error (see
Error Indicators and Warnings).
Error Indicators and Warnings
Note: nag_stat_inv_cdf_gamma_vector (g01tf) may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the function:
Cases prefixed with W are classified as warnings and
do not generate an error of type NAG:error_n. See nag_issue_warnings.
- W
-
On entry, at least one value of
tail,
p,
a, or
b was invalid.
Check
ivalid for more information.
-
-
Constraint: .
-
-
Constraint: .
-
-
Constraint: .
-
-
Constraint: .
-
An unexpected error has been triggered by this routine. Please
contact
NAG.
-
Your licence key may have expired or may not have been installed correctly.
-
Dynamic memory allocation failed.
Accuracy
In most cases the relative accuracy of the results should be as specified by
tol. However, for very small values of
or very small values of
there may be some loss of accuracy.
Further Comments
None.
Example
This example reads lower tail probabilities for several gamma distributions, and calculates and prints the corresponding deviates until the end of data is reached.
Open in the MATLAB editor:
g01tf_example
function g01tf_example
fprintf('g01tf example results\n\n');
tail = {'L'};
p = [0.01; 0.428; 0.869];
a = [1; 7.5; 45];
b = [20; 0.1; 10];
[x, ivalid, ifail] = g01tf( ...
tail, p, a, b);
fprintf(' tail p a b x ivalid\n');
ltail = numel(tail);
lp = numel(p);
la = numel(a);
lb = numel(b);
len = max ([ltail, lp, la, lb]);
for i=0:len-1
fprintf('%5s%8.3f%8.3f%8.3f%10.3f%5d\n', tail{mod(i, ltail)+1}, ...
p(mod(i,lp)+1), a(mod(i,la)+1), b(mod(i,lb)+1), x(i+1), ivalid(i+1));
end
g01tf example results
tail p a b x ivalid
L 0.010 1.000 20.000 0.201 0
L 0.428 7.500 0.100 0.670 0
L 0.869 45.000 10.000 525.839 0
PDF version (NAG web site
, 64-bit version, 64-bit version)
© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2015