NAG FL Interface
d01fcf (md_​adapt)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

d01fcf attempts to evaluate a multidimensional integral (up to 15 dimensions), with constant and finite limits, to a specified relative accuracy, using an adaptive subdivision strategy.

2 Specification

Fortran Interface
Subroutine d01fcf ( ndim, a, b, minpts, maxpts, f, eps, acc, lenwrk, wrkstr, finval, ifail)
Integer, Intent (In) :: ndim, maxpts, lenwrk
Integer, Intent (Inout) :: minpts, ifail
Real (Kind=nag_wp), External :: f
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 <nag.h>
void  d01fcf_ (const Integer *ndim, const double a[], const double b[], Integer *minpts, const Integer *maxpts,
double (NAG_CALL *f)(const Integer *ndim, const double z[]),
const double *eps, double *acc, const Integer *lenwrk, double wrkstr[], double *finval, Integer *ifail)
The routine may be called by the names d01fcf or nagf_quad_md_adapt.

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 f, and also set the minimum and maximum acceptable number of calls to f (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 f 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 f 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 Integer Input
On entry: n, the number of dimensions of the integral.
Constraint: 2ndim15.
2: a(ndim) Real (Kind=nag_wp) array Input
On entry: the lower limits of integration, ai, for i=1,2,,n.
3: b(ndim) Real (Kind=nag_wp) array Input
On entry: the upper limits of integration, bi, for i=1,2,,n.
4: minpts Integer Input/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 Integer Input
On entry: the maximum number of integrand evaluations to be allowed.
  • maxptsminpts;
  • maxptsα, where α=2ndim+2×ndim2+2×ndim+1.
6: f real (Kind=nag_wp) Function, supplied by the user. External Procedure
f must return the value of the integrand at a given point.
The specification of f is:
Fortran Interface
Function f ( ndim, z)
Real (Kind=nag_wp) :: f
Integer, Intent (In) :: ndim
Real (Kind=nag_wp), Intent (In) :: z(ndim)
C Header Interface
double  f (const Integer *ndim, const double z[])
1: ndim Integer Input
On entry: n, the number of dimensions of the integral.
2: z(ndim) Real (Kind=nag_wp) array Input
On entry: the coordinates of the point at which the integrand f must be evaluated.
f 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: f 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 Integer Input
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(ndim+2)×(1+maxpts/α) (see argument maxpts for α).
If lenwrk is less than this, d01fcf will usually run less efficiently and may fail.
Constraint: lenwrk2×ndim+4.
10: wrkstr(lenwrk) Real (Kind=nag_wp) array Workspace
11: finval Real (Kind=nag_wp) Output
On exit: the best estimate obtained for the integral.
12: 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 -1 is recommended since useful values can be provided in some output arguments even when ifail0 on exit. 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:
Note: in some cases d01fcf may return useful information.
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: minptsmaxpts.
On entry, ndim=value.
Constraint: ndim15.
On entry, ndim=value.
Constraint: ndim2.
maxpts too small to obtain requested accuracy eps: maxpts=value and eps=value.
lenwrk was too small to complete computation. finval and acc contain estimates of integral and relative error, but acc is greater than eps.
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

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 f, and hence the maximum time that could be taken will be proportional to maxpts.

10 Example

This example estimates the integral
01 01 01 01 4 z1 z32 exp(2z1z3) (1+z2+z4) 2 dz4 dz3 dz2 dz1 = 0.575364 .  
The accuracy requested is one part in 10000.

10.1 Program Text

Program Text (d01fcfe.f90)

10.2 Program Data


10.3 Program Results

Program Results (d01fcfe.r)