NAG Library Routine Document
d01akf
(dim1_fin_osc)
1
Purpose
d01akf is an adaptive integrator, especially suited to oscillating, nonsingular integrands, which calculates an approximation to the integral of a function
over a finite interval
:
2
Specification
Fortran Interface
Subroutine d01akf ( |
f,
a,
b,
epsabs,
epsrel,
result,
abserr,
w,
lw,
iw,
liw,
ifail) |
Integer, Intent (In) | :: |
lw,
liw | Integer, Intent (Inout) | :: |
ifail | Integer, Intent (Out) | :: |
iw(liw) | Real (Kind=nag_wp), External | :: |
f | Real (Kind=nag_wp), Intent (In) | :: |
a,
b,
epsabs,
epsrel | Real (Kind=nag_wp), Intent (Out) | :: |
result,
abserr,
w(lw) |
|
C Header Interface
#include nagmk26.h
void |
d01akf_ (
double (NAG_CALL *f)(
const double *x),
const double *a,
const double *b,
const double *epsabs,
const double *epsrel,
double *result,
double *abserr,
double w[],
const Integer *lw,
Integer iw[],
const Integer *liw,
Integer *ifail) |
|
3
Description
d01akf is based on the QUADPACK routine QAG (see
Piessens et al. (1983)). It is an adaptive routine, using the Gauss
-point and Kronrod
-point rules. A ‘global’ acceptance criterion (as defined by
Malcolm and Simpson (1976)) is used. The local error estimation is described in
Piessens et al. (1983).
Because d01akf is based on integration rules of high order, it is especially suitable for nonsingular oscillating integrands.
d01akf requires you to supply a function to evaluate the integrand at a single point.
The routine
d01auf uses an identical algorithm but requires you to supply a subroutine to evaluate the integrand at an array of points. Therefore
d01auf will be more efficient if the evaluation can be performed in vector mode on a vector-processing machine.
4
References
Malcolm M A and Simpson R B (1976) Local versus global strategies for adaptive quadrature ACM Trans. Math. Software 1 129–146
Piessens R (1973) An algorithm for automatic integration Angew. Inf. 15 399–401
Piessens R, de Doncker–Kapenga E, Überhuber C and Kahaner D (1983) QUADPACK, A Subroutine Package for Automatic Integration Springer–Verlag
5
Arguments
- 1: – 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
Real (Kind=nag_wp) | :: | f | Real (Kind=nag_wp), Intent (In) | :: |
x |
|
C Header Interface
#include nagmk26.h
double |
f (
const double *x) |
|
- 1: – Real (Kind=nag_wp)Input
-
On entry: the point at which the integrand must be evaluated.
f must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d01akf 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
d01akf. If your code inadvertently
does return any NaNs or infinities,
d01akf is likely to produce unexpected results.
- 2: – Real (Kind=nag_wp)Input
-
On entry: , the lower limit of integration.
- 3: – Real (Kind=nag_wp)Input
-
On entry: , the upper limit of integration. It is not necessary that .
- 4: – Real (Kind=nag_wp)Input
-
On entry: the absolute accuracy required. If
epsabs is negative, the absolute value is used. See
Section 7.
- 5: – Real (Kind=nag_wp)Input
-
On entry: the relative accuracy required. If
epsrel is negative, the absolute value is used. See
Section 7.
- 6: – Real (Kind=nag_wp)Output
-
On exit: the approximation to the integral .
- 7: – Real (Kind=nag_wp)Output
-
On exit: an estimate of the modulus of the absolute error, which should be an upper bound for .
- 8: – Real (Kind=nag_wp) arrayOutput
-
On exit: details of the computation see
Section 9 for more information.
- 9: – IntegerInput
-
On entry: the dimension of the array
w as declared in the (sub)program from which
d01akf is called. The value of
lw (together with that of
liw) imposes a bound on the number of sub-intervals into which the interval of integration may be divided by the routine. The number of sub-intervals cannot exceed
. The more difficult the integrand, the larger
lw should be.
Suggested value:
to is adequate for most problems.
Constraint:
.
- 10: – Integer arrayOutput
-
On exit: contains the actual number of sub-intervals used. The rest of the array is used as workspace.
- 11: – IntegerInput
-
On entry: the dimension of the array
iw as declared in the (sub)program from which
d01akf is called. The number of sub-intervals into which the interval of integration may be divided cannot exceed
liw.
Suggested value:
.
Constraint:
.
- 12: – 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:
-
The maximum number of subdivisions allowed with the given workspace has been reached without the accuracy requirements being achieved. Look at the integrand in order to determine the integration difficulties. If necessary, another integrator, which is designed for handling the type of difficulty involved, must be used. Alternatively, consider relaxing the accuracy requirements specified by
epsabs and
epsrel, or increasing the amount of workspace.
-
Round-off error prevents the requested tolerance from being achieved. Consider requesting less accuracy.
-
Extremely bad local integrand behaviour causes a very strong subdivision around one (or more) points of the interval. The same advice applies as in the case of .
-
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
d01akf cannot guarantee, but in practice usually achieves, the following accuracy:
where
and
epsabs and
epsrel are user-specified absolute and relative error tolerances. Moreover, it returns the quantity
abserr which, in normal circumstances, satisfies
8
Parallelism and Performance
d01akf is not threaded in any implementation.
The time taken by d01akf depends on the integrand and the accuracy required.
If
on exit, then you may wish to examine the contents of the array
w, which contains the end points of the sub-intervals used by
d01akf along with the integral contributions and error estimates over these sub-intervals.
Specifically, for
, let
denote the approximation to the value of the integral over the sub-interval
in the partition of
and
be the corresponding absolute error estimate. Then,
and
. The value of
is returned in
,
and the values
,
,
and
are stored consecutively in the
array
w,
that is:
- ,
- ,
- and
- .
10
Example
10.1
Program Text
Program Text (d01akfe.f90)
10.2
Program Data
None.
10.3
Program Results
Program Results (d01akfe.r)