NAG Library Routine Document

Integer, Intent (In)	::	ndim, maxpts, lenwrk
Integer, Intent (Inout)	::	minpts, ifail
Real (Kind=nag_wp), External	::	functn
Real (Kind=nag_wp), Intent (In)	::	a(ndim), b(ndim), eps
Real (Kind=nag_wp), Intent (Out)	::	acc, wrkstr(lenwrk), finval

C Header Interface

#include <nagmk26.h>

void	d01fcf_ (const Integer ndim, const double a[], const double b[], Integer minpts, const Integer maxpts, double (NAG_CALL functn)(const Integer ndim, const double z[]), const double eps, double acc, const Integer lenwrk, double wrkstr[], double finval, Integer ifail)

3

Description

d01fcf returns an estimate of a multidimensional integral over a hyper-rectangle (i.e., with constant limits), and also an estimate of the relative error. You set the relative accuracy required, return values for the integrand via a routine argument functn, and also set the minimum and maximum acceptable number of calls to functn (in minpts and maxpts).

The routine operates by repeated subdivision of the hyper-rectangular region into smaller hyper-rectangles. In each subregion, the integral is estimated using a seventh-degree rule, and an error estimate is obtained by comparison with a fifth-degree rule which uses a subset of the same points. The fourth differences of the integrand along each coordinate axis are evaluated, and the subregion is marked for possible future subdivision in half along that coordinate axis which has the largest absolute fourth difference.

If the estimated errors, totalled over the subregions, exceed the requested relative error (or if fewer than minpts calls to functn have been made), further subdivision is necessary, and is performed on the subregion with the largest estimated error, that subregion being halved along the appropriate coordinate axis.

The routine will fail if the requested relative error level has not been attained by the time maxpts calls to functn have been made; or, if the amount lenwrk of working storage is insufficient. A formula for the recommended value of lenwrk is given in Section 5. If a smaller value is used, and is exhausted in the course of execution, the routine switches to a less efficient mode of operation; only if this mode also breaks down is insufficient storage reported.

d01fcf is based on the HALF subroutine developed by van Dooren and de Ridder (1976). It uses a different basic rule, described in Genz and Malik (1980).

4

References

Genz A C and Malik A A (1980) An adaptive algorithm for numerical integration over an N-dimensional rectangular region J. Comput. Appl. Math. 6 295–302

van Dooren P and de Ridder L (1976) An adaptive algorithm for numerical integration over an N-dimensional cube J. Comput. Appl. Math. 2 207–217

5

Arguments

1: $ndim$ – IntegerInput

On entry:

n

, the number of dimensions of the integral.

Constraint:

2 \leq ndim \leq 15

2: $a (ndim)$ – Real (Kind=nag_wp) arrayInput

On entry: the lower limits of integration,

a_{i}

, for

i = 1, 2, \dots, n

3: $b (ndim)$ – Real (Kind=nag_wp) arrayInput

On entry: the upper limits of integration,

b_{i}

, for

i = 1, 2, \dots, n

4: $minpts$ – IntegerInput/Output

On entry: must be set to the minimum number of integrand evaluations to be allowed.

On exit: contains the actual number of integrand evaluations used by d01fcf.

5: $maxpts$ – IntegerInput

On entry: the maximum number of integrand evaluations to be allowed.

Constraints:

$maxpts \geq minpts$ ;
$maxpts \geq α$ , where $α = 2^{ndim} + 2 \times {ndim}^{2} + 2 \times ndim + 1$ .

6: $functn$ – real (Kind=nag_wp) Function, supplied by the user.External Procedure

functn must return the value of the integrand

f

at a given point.

The specification of functn is:

Fortran Interface

Function functn (

ndim, z)

Real (Kind=nag_wp)	::	functn
Integer, Intent (In)	::	ndim
Real (Kind=nag_wp), Intent (In)	::	z(ndim)

C Header Interface

#include <nagmk26.h>

double

functn (const Integer *ndim, const double z[])

1: $ndim$ – IntegerInput: On entry: $n$ , the number of dimensions of the integral.
2: $z (ndim)$ – Real (Kind=nag_wp) arrayInput: On entry: the coordinates of the point at which the integrand $f$ must be evaluated.

functn must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d01fcf is called. Arguments denoted as Input must not be changed by this procedure.

Note: functn should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d01fcf. If your code inadvertently does return any NaNs or infinities, d01fcf is likely to produce unexpected results.

7: $eps$ – Real (Kind=nag_wp)Input

On entry: the relative error acceptable to you. When the solution is zero or very small relative accuracy may not be achievable but you may still set eps to a reasonable value and check for the error exit

ifail = 2

Constraint:

eps > 0.0

8: $acc$ – Real (Kind=nag_wp)Output

On exit: the estimated relative error in finval.

9: $lenwrk$ – IntegerInput

On entry: the dimension of the array wrkstr as declared in the (sub)program from which d01fcf is called.

Suggested value: for maximum efficiency,

lenwrk \geq (ndim + 2) \times (1 + maxpts / α)

(see argument maxpts for

α

If lenwrk is less than this, d01fcf will usually run less efficiently and may fail.

Constraint:

lenwrk \geq 2 \times ndim + 4

10: $wrkstr (lenwrk)$ – Real (Kind=nag_wp) arrayWorkspace

11: $finval$ – Real (Kind=nag_wp)Output

On exit: the best estimate obtained for the integral.

12: $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, because for this routine the values of the output arguments may be useful even if

ifail \neq 0

on exit, the recommended value is

- 1

. 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).

Note: d01fcf may return useful information for one or more of the following detected errors or warnings.

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $eps = 〈value〉$ .
Constraint: $eps > 0.0$ .

On entry, lenwrk is too small. $lenwrk = 〈value〉$ . Minimum possible dimension: $〈value〉$ .

On entry, maxpts is too small. $maxpts = 〈value〉$ . Minimum possible dimension: $〈value〉$ .

On entry, $minpts = 〈value〉$ and $maxpts = 〈value〉$ .
Constraint: $minpts \leq maxpts$ .

On entry, $ndim = 〈value〉$ .
Constraint: $ndim \leq 15$ .

On entry, $ndim = 〈value〉$ .
Constraint: $ndim \geq 2$ .

$ifail = 2$: maxpts too small to obtain requested accuracy eps: $maxpts = 〈value〉$ and $eps = 〈value〉$ .

$ifail = 3$: lenwrk was too small to complete computation. finval and acc contain estimates of integral and relative error, but acc is greater than eps.

$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.

7

Accuracy

A relative error estimate is output through the argument acc.

8

Parallelism and Performance

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

d01fcf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

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

Execution time will usually be dominated by the time taken to evaluate functn, and hence the maximum time that could be taken will be proportional to maxpts.