NAG Library Routine Document

d01gaf integrates a function which is specified numerically at four or more points, over the whole of its specified range, using third-order finite difference formulae with error estimates, according to a method due to Gill and Miller (1972).

2

Specification

Fortran Interface

Subroutine d01gaf (

x, y, n, ans, er, ifail)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	x(n), y(n)
Real (Kind=nag_wp), Intent (Out)	::	ans, er

C Header Interface

#include <nagmk26.h>

void	d01gaf_ (const double x[], const double y[], const Integer n, double ans, double er, Integer ifail)

3

Description

d01gaf evaluates the definite integral

I = \int_{x_{1}}^{x_{n}} y (x) d x,

where the function

y

is specified at the

n

-points

x_{1}, x_{2}, \dots, x_{n}

, which should be all distinct, and in either ascending or descending order. The integral between successive points is calculated by a four-point finite difference formula centred on the interval concerned, except in the case of the first and last intervals, where four-point forward and backward difference formulae respectively are employed. If

n

is less than

4

, the routine fails. An approximation to the truncation error is integrated and added to the result. It is also returned separately to give an estimate of the uncertainty in the result. The method is due to Gill and Miller (1972).

4

References

Gill P E and Miller G F (1972) An algorithm for the integration of unequally spaced data Comput. J. 15 80–83

5

Arguments

1: $x (n)$ – Real (Kind=nag_wp) arrayInput: On entry: the values of the independent variable, i.e., the $x_{1}, x_{2}, \dots, x_{n}$ .

Constraint: either $x (1) < x (2) < \dots < x (n)$ or $x (1) > x (2) > \dots > x (n)$ .
2: $y (n)$ – Real (Kind=nag_wp) arrayInput: On entry: the values of the dependent variable $y_{i}$ at the points $x_{i}$ , for $i = 1, 2, \dots, n$ .
3: $n$ – IntegerInput: On entry: $n$ , the number of points.

Constraint: $n \geq 4$ .
4: $ans$ – Real (Kind=nag_wp)Output: On exit: the estimated value of the integral.
5: $er$ – Real (Kind=nag_wp)Output: On exit: an estimate of the uncertainty in ans.
6: $ifail$ – IntegerInput/Output: On entry: ifail must be set to $0$ , $- 1 or 1$ . 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 $- 1 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 argument, the recommended value is $0$ . 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

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $n = 〈value〉$ .
Constraint: $n \geq 4$ .

$ifail = 2$: On entry, $x (1) = 〈value〉$ and $x (2) = 〈value〉$ , $x (I - 1) = 〈value〉$ , $x (I) = 〈value〉$ and $I = 〈value〉$ .
Constraint: either $x (1) < x (2) < \dots < x (n)$ or $x (1) > x (2) > \dots > x (n)$ .

$ifail = 3$: On entry, $I = 〈value〉$ , $x (I) = 〈value〉$ and $x (I - 1) = 〈value〉$ .
Constraint: $x (I) \neq x (I - 1)$ .

$ifail = - 99$: 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.

$ifail = - 399$: 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.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

No error is reported arising from the relative magnitudes of ans and er on return, due to the difficulty when the true answer is zero.

7

Accuracy

No accuracy level is specified by you before calling d01gaf but on return the absolute value of er is an approximation to, but not necessarily a bound for,

|I - ans|

. If on exit

ifail > 0

, both ans and er are returned as zero.

8

Parallelism and Performance

d01gaf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9

Further Comments

The time taken by d01gaf depends on the number of points supplied,

n

In their paper, Gill and Miller (1972) do not add the quantity er to ans before return. However, extensive tests have shown that a dramatic reduction in the error often results from such addition. In other cases, it does not make an improvement, but these tend to be cases of low accuracy in which the modified answer is not significantly inferior to the unmodified one. You have the option of recovering the Gill–Miller answer by subtracting er from ans on return from the routine.

10

Example

This example evaluates the integral

\int_{0}^{1} \frac{4}{1 + x^{2}} d x = π

reading in the function values at

21

unequally spaced points.

NAG Library Routine Document

d01gaf (dim1_data)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose