NAG Library Routine Document
s14baf
(gamma_incomplete)
1
Purpose
s14baf computes values for the incomplete gamma functions and .
2
Specification
Fortran Interface
Integer, Intent (Inout) | :: |
ifail | Real (Kind=nag_wp), Intent (In) | :: |
a,
x,
tol | Real (Kind=nag_wp), Intent (Out) | :: |
p,
q |
|
C Header Interface
#include nagmk26.h
void |
s14baf_ (
const double *a,
const double *x,
const double *tol,
double *p,
double *q,
Integer *ifail) |
|
3
Description
s14baf evaluates the incomplete gamma functions in the normalized form
with
and
, to a user-specified accuracy. With this normalization,
.
Several methods are used to evaluate the functions depending on the arguments
and
, the methods including Taylor expansion for
, Legendre's continued fraction for
, and power series for
. When both
and
are large, and
, the uniform asymptotic expansion of
Temme (1987) is employed for greater efficiency – specifically, this expansion is used when
and
.
Once either or is computed, the other is obtained by subtraction from . In order to avoid loss of relative precision in this subtraction, the smaller of and is computed first.
This routine is derived from the subroutine GAM in
Gautschi (1979b).
4
References
Gautschi W (1979a) A computational procedure for incomplete gamma functions ACM Trans. Math. Software 5 466–481
Gautschi W (1979b) Algorithm 542: Incomplete gamma functions ACM Trans. Math. Software 5 482–489
Temme N M (1987) On the computation of the incomplete gamma functions for large values of the parameters Algorithms for Approximation (eds J C Mason and M G Cox) Oxford University Press
5
Arguments
- 1: – Real (Kind=nag_wp)Input
-
On entry: the argument of the functions.
Constraint:
.
- 2: – Real (Kind=nag_wp)Input
-
On entry: the argument of the functions.
Constraint:
.
- 3: – Real (Kind=nag_wp)Input
-
On entry: the relative accuracy required by you in the results. If
s14baf is entered with
tol greater than
or less than
machine precision, then the value of
machine precision is used instead.
- 4: – Real (Kind=nag_wp)Output
- 5: – Real (Kind=nag_wp)Output
-
On exit: the values of the functions and respectively.
- 6: – 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:
-
-
-
Convergence of the Taylor series or Legendre continued fraction fails within
iterations. This error is extremely unlikely to occur; if it does, contact
NAG.
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
There are rare occasions when the relative accuracy attained is somewhat less than that specified by argument
tol. However, the error should never exceed more than one or two decimal places. Note also that there is a limit of
decimal places on the achievable accuracy, because constants in the routine are given to this precision.
8
Parallelism and Performance
s14baf is not threaded in any implementation.
The time taken for a call of
s14baf depends on the precision requested through
tol, and also varies slightly with the input arguments
and
.
10
Example
This example reads values of the argument and from a file, evaluates the function and prints the results.
10.1
Program Text
Program Text (s14bafe.f90)
10.2
Program Data
Program Data (s14bafe.d)
10.3
Program Results
Program Results (s14bafe.r)