NAG FL Interface
s14bnf (gamma_​incomplete_​vector)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

s14bnf computes an array of values for the incomplete gamma functions P(a,x) and Q(a,x).

2 Specification

Fortran Interface
Subroutine s14bnf ( n, a, x, tol, p, q, ivalid, ifail)
Integer, Intent (In) :: n
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: ivalid(n)
Real (Kind=nag_wp), Intent (In) :: a(n), x(n), tol
Real (Kind=nag_wp), Intent (Out) :: p(n), q(n)
C Header Interface
#include <nag.h>
void  s14bnf_ (const Integer *n, const double a[], const double x[], const double *tol, double p[], double q[], Integer ivalid[], Integer *ifail)
The routine may be called by the names s14bnf or nagf_specfun_gamma_incomplete_vector.

3 Description

s14bnf evaluates the incomplete gamma functions in the normalized form, for an array of arguments ai,xi, for i=1,2,,n.
P(a,x) = 1Γ(a) 0x ta-1 e-t dt ,  
Q(a,x) = 1Γ (a) x ta- 1 e-t dt ,  
with x0 and a>0, to a user-specified accuracy. With this normalization, P(a,x)+Q(a,x)=1.
Several methods are used to evaluate the functions depending on the arguments a and x, the methods including Taylor expansion for P(a,x), Legendre's continued fraction for Q(a,x), and power series for Q(a,x). When both a and x are large, and ax, the uniform asymptotic expansion of Temme (1987) is employed for greater efficiency – specifically, this expansion is used when a20 and 0.7ax1.4a.
Once either P or Q is computed, the other is obtained by subtraction from 1. In order to avoid loss of relative precision in this subtraction, the smaller of P and Q 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: n Integer Input
On entry: n, the number of points.
Constraint: n0.
2: a(n) Real (Kind=nag_wp) array Input
On entry: the argument ai of the function, for i=1,2,,n.
Constraint: a(i)>0, for i=1,2,,n.
3: x(n) Real (Kind=nag_wp) array Input
On entry: the argument xi of the function, for i=1,2,,n.
Constraint: x(i)0, for i=1,2,,n.
4: tol Real (Kind=nag_wp) Input
On entry: the relative accuracy required by you in the results. If s14bnf is entered with tol greater than 1.0 or less than machine precision, then the value of machine precision is used instead.
5: p(n) Real (Kind=nag_wp) array Output
On exit: P(ai,xi), the function values.
6: q(n) Real (Kind=nag_wp) array Output
On exit: Q(ai,xi), the function values.
7: ivalid(n) Integer array Output
On exit: ivalid(i) contains the error code for ai and xi, for i=1,2,,n.
No error.
Algorithm fails to terminate.
8: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry ifail=0 or −1, 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 x was invalid.
Check ivalid for more information.
On entry, n=value.
Constraint: n0.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface 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 18 decimal places on the achievable accuracy, because constants in the routine are given to this precision.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
s14bnf is not threaded in any implementation.

9 Further Comments

The time taken for a call of s14bnf depends on the precision requested through tol, and n.

10 Example

This example reads values of a and x from a file, evaluates the functions at each value of ai and xi and prints the results.

10.1 Program Text

Program Text (s14bnfe.f90)

10.2 Program Data

Program Data (s14bnfe.d)

10.3 Program Results

Program Results (s14bnfe.r)