D01 Chapter Contents
D01 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentD01APF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

D01APF is an adaptive integrator which calculates an approximation to the integral of a function $g\left(x\right)w\left(x\right)$ over a finite interval $\left[a,b\right]$:
 $I= ∫ab gx wx dx$
where the weight function $w$ has end point singularities of algebraico-logarithmic type.

## 2  Specification

 SUBROUTINE D01APF ( G, A, B, ALFA, BETA, KEY, EPSABS, EPSREL, RESULT, ABSERR, W, LW, IW, LIW, IFAIL)
 INTEGER KEY, LW, IW(LIW), LIW, IFAIL REAL (KIND=nag_wp) G, A, B, ALFA, BETA, EPSABS, EPSREL, RESULT, ABSERR, W(LW) EXTERNAL G

## 3  Description

D01APF is based on the QUADPACK routine QAWSE (see Piessens et al. (1983)) and integrates a function of the form $g\left(x\right)w\left(x\right)$, where the weight function $w\left(x\right)$ may have algebraico-logarithmic singularities at the end points $a$ and/or $b$. The strategy is a modification of that in D01AKF. We start by bisecting the original interval and applying modified Clenshaw–Curtis integration of orders $12$ and $24$ to both halves. Clenshaw–Curtis integration is then used on all sub-intervals which have $a$ or $b$ as one of their end points (see Piessens et al. (1974)). On the other sub-intervals Gauss–Kronrod ($7$$15$ point) integration is carried out.
A ‘global’ acceptance criterion (as defined by Malcolm and Simpson (1976)) is used. The local error estimation control is described in Piessens et al. (1983).
Malcolm M A and Simpson R B (1976) Local versus global strategies for adaptive quadrature ACM Trans. Math. Software 1 129–146
Piessens R, de Doncker–Kapenga E, Überhuber C and Kahaner D (1983) QUADPACK, A Subroutine Package for Automatic Integration Springer–Verlag
Piessens R, Mertens I and Branders M (1974) Integration of functions having end-point singularities Angew. Inf. 16 65–68

## 5  Parameters

1:     $\mathrm{G}$ – REAL (KIND=nag_wp) FUNCTION, supplied by the user.External Procedure
G must return the value of the function $g$ at a given point X.
The specification of G is:
 FUNCTION G ( X)
 REAL (KIND=nag_wp) G
 REAL (KIND=nag_wp) X
1:     $\mathrm{X}$ – REAL (KIND=nag_wp)Input
On entry: the point at which the function $g$ must be evaluated.
G must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D01APF is called. Parameters denoted as Input must not be changed by this procedure.
2:     $\mathrm{A}$ – REAL (KIND=nag_wp)Input
On entry: $a$, the lower limit of integration.
3:     $\mathrm{B}$ – REAL (KIND=nag_wp)Input
On entry: $b$, the upper limit of integration.
Constraint: ${\mathbf{B}}>{\mathbf{A}}$.
4:     $\mathrm{ALFA}$ – REAL (KIND=nag_wp)Input
On entry: the parameter $\alpha$ in the weight function.
Constraint: ${\mathbf{ALFA}}>-1.0$.
5:     $\mathrm{BETA}$ – REAL (KIND=nag_wp)Input
On entry: the parameter $\beta$ in the weight function.
Constraint: ${\mathbf{BETA}}>-1.0$.
6:     $\mathrm{KEY}$ – INTEGERInput
On entry: indicates which weight function is to be used.
${\mathbf{KEY}}=1$
$w\left(x\right)={\left(x-a\right)}^{\alpha }{\left(b-x\right)}^{\beta }$.
${\mathbf{KEY}}=2$
$w\left(x\right)={\left(x-a\right)}^{\alpha }{\left(b-x\right)}^{\beta }\mathrm{ln}\left(x-a\right)$.
${\mathbf{KEY}}=3$
$w\left(x\right)={\left(x-a\right)}^{\alpha }{\left(b-x\right)}^{\beta }\mathrm{ln}\left(b-x\right)$.
${\mathbf{KEY}}=4$
$w\left(x\right)={\left(x-a\right)}^{\alpha }{\left(b-x\right)}^{\beta }\mathrm{ln}\left(x-a\right)\mathrm{ln}\left(b-x\right)$.
Constraint: ${\mathbf{KEY}}=1$, $2$, $3$ or $4$.
7:     $\mathrm{EPSABS}$ – REAL (KIND=nag_wp)Input
On entry: the absolute accuracy required. If EPSABS is negative, the absolute value is used. See Section 7.
8:     $\mathrm{EPSREL}$ – REAL (KIND=nag_wp)Input
On entry: the relative accuracy required. If EPSREL is negative, the absolute value is used. See Section 7.
9:     $\mathrm{RESULT}$ – REAL (KIND=nag_wp)Output
On exit: the approximation to the integral $I$.
10:   $\mathrm{ABSERR}$ – REAL (KIND=nag_wp)Output
On exit: an estimate of the modulus of the absolute error, which should be an upper bound for $\left|I-{\mathbf{RESULT}}\right|$.
11:   $\mathrm{W}\left({\mathbf{LW}}\right)$ – REAL (KIND=nag_wp) arrayOutput
On exit: details of the computation see Section 9 for more information.
12:   $\mathrm{LW}$ – INTEGERInput
On entry: the dimension of the array W as declared in the (sub)program from which D01APF 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 ${\mathbf{LW}}/4$. The more difficult the integrand, the larger LW should be.
Suggested value: ${\mathbf{LW}}=800$ to $2000$ is adequate for most problems.
Constraint: ${\mathbf{LW}}\ge 8$.
13:   $\mathrm{IW}\left({\mathbf{LIW}}\right)$ – INTEGER arrayOutput
On exit: ${\mathbf{IW}}\left(1\right)$ contains the actual number of sub-intervals used. The rest of the array is used as workspace.
14:   $\mathrm{LIW}$ – INTEGERInput
On entry: the dimension of the array IW as declared in the (sub)program from which D01APF is called. The number of sub-intervals into which the interval of integration may be divided cannot exceed LIW.
Suggested value: ${\mathbf{LIW}}={\mathbf{LW}}/4$.
Constraint: ${\mathbf{LIW}}\ge 2$.
15:   $\mathrm{IFAIL}$ – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ 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 parameters may be useful even if ${\mathbf{IFAIL}}\ne {\mathbf{0}}$ on exit, the recommended value is $-1$. When the value $-\mathbf{1}\text{​ or ​}1$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Note: D01APF may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
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 the position of a discontinuity or a singularity of algebraico-logarithmic type within the interval can be determined, the interval must be split up at this point and the integrator called on the subranges. 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.
${\mathbf{IFAIL}}=2$
Round-off error prevents the requested tolerance from being achieved. Consider requesting less accuracy.
${\mathbf{IFAIL}}=3$
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 ${\mathbf{IFAIL}}={\mathbf{1}}$.
${\mathbf{IFAIL}}=4$
 On entry, ${\mathbf{B}}\le {\mathbf{A}}$, or ${\mathbf{ALFA}}\le -1.0$, or ${\mathbf{BETA}}\le -1.0$, or ${\mathbf{KEY}}\ne 1$, $2$, $3$ or $4$.
${\mathbf{IFAIL}}=5$
 On entry, ${\mathbf{LW}}<8$, or ${\mathbf{LIW}}<2$.
${\mathbf{IFAIL}}=-99$
See Section 3.8 in the Essential Introduction for further information.
${\mathbf{IFAIL}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.
${\mathbf{IFAIL}}=-999$
Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

## 7  Accuracy

D01APF cannot guarantee, but in practice usually achieves, the following accuracy:
 $I-RESULT≤tol,$
where
 $tol=maxEPSABS,EPSREL×I ,$
and EPSABS and EPSREL are user-specified absolute and relative error tolerances. Moreover, it returns the quantity ABSERR which, in normal circumstances, satisfies
 $I-RESULT≤ABSERR≤tol.$

## 8  Parallelism and Performance

Not applicable.

The time taken by D01APF depends on the integrand and the accuracy required.
If ${\mathbf{IFAIL}}\ne {\mathbf{0}}$ 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 D01APF along with the integral contributions and error estimates over these sub-intervals.
Specifically, for $i=1,2,\dots ,n$, let ${r}_{i}$ denote the approximation to the value of the integral over the sub-interval $\left[{a}_{i},{b}_{i}\right]$ in the partition of $\left[a,b\right]$ and ${e}_{i}$ be the corresponding absolute error estimate. Then, $\underset{{a}_{i}}{\overset{{b}_{i}}{\int }}f\left(x\right)w\left(x\right)dx\simeq {r}_{i}$ and ${\mathbf{RESULT}}=\sum _{i=1}^{n}{r}_{i}$. The value of $n$ is returned in ${\mathbf{IW}}\left(1\right)$, and the values ${a}_{i}$, ${b}_{i}$, ${e}_{i}$ and ${r}_{i}$ are stored consecutively in the array W, that is:
• ${a}_{i}={\mathbf{W}}\left(i\right)$,
• ${b}_{i}={\mathbf{W}}\left(n+i\right)$,
• ${e}_{i}={\mathbf{W}}\left(2n+i\right)$ and
• ${r}_{i}={\mathbf{W}}\left(3n+i\right)$.

## 10  Example

This example computes
 $∫ 0 1 ln⁡x cos10πx dx and ∫01 sin10x x1-x dx .$

### 10.1  Program Text

Program Text (d01apfe.f90)

None.

### 10.3  Program Results

Program Results (d01apfe.r)