NAG Library Routine Document
c05axf (contfn_cntin_rcomm)
1
Purpose
c05axf attempts to locate a zero of a continuous function using a continuation method based on a secant iteration. It uses reverse communication for evaluating the function.
2
Specification
Fortran Interface
Integer, Intent (In)  ::  ir  Integer, Intent (Inout)  ::  ind, ifail  Real (Kind=nag_wp), Intent (In)  ::  fx, tol, scal  Real (Kind=nag_wp), Intent (Inout)  ::  x, c(26) 

C Header Interface
#include <nagmk26.h>
void 
c05axf_ (double *x, const double *fx, const double *tol, const Integer *ir, const double *scal, double c[], Integer *ind, Integer *ifail) 

3
Description
c05axf uses a modified version of an algorithm given in
Swift and Lindfield (1978) to compute a zero
$\alpha $ of a continuous function
$f\left(x\right)$. The algorithm used is based on a continuation method in which a sequence of problems
are solved, where
$1={\theta}_{0}>{\theta}_{1}>\cdots >{\theta}_{m}=0$ (the value of
$m$ is determined as the algorithm proceeds) and where
${x}_{0}$ is your initial estimate for the zero of
$f\left(x\right)$. For each
${\theta}_{r}$ the current problem is solved by a robust secant iteration using the solution from earlier problems to compute an initial estimate.
You must supply an error tolerance
tol.
tol is used directly to control the accuracy of solution of the final problem (
${\theta}_{m}=0$)
in the continuation method, and
$\sqrt{{\mathbf{tol}}}$ is used to control the accuracy in the intermediate problems
(
${\theta}_{1},{\theta}_{2},\dots ,{\theta}_{m1}$).
4
References
Swift A and Lindfield G R (1978) Comparison of a continuation method for the numerical solution of a single nonlinear equation Comput. J. 21 359–362
5
Arguments
Note: this routine uses
reverse communication. Its use involves an initial entry, intermediate exits and reentries, and a final exit, as indicated by the argument
ind. Between intermediate exits and reentries,
all arguments other than fx must remain unchanged.
 1: $\mathbf{x}$ – Real (Kind=nag_wp)Input/Output

On initial entry: an initial approximation to the zero.
On intermediate exit:
the point at which $f$ must be evaluated before reentry to the routine.
On final exit: the final approximation to the zero.
 2: $\mathbf{fx}$ – Real (Kind=nag_wp)Input

On initial entry: if
${\mathbf{ind}}=1$,
fx need not be set.
If
${\mathbf{ind}}=1$,
fx must contain
$f\left({\mathbf{x}}\right)$ for the initial value of
x.
On intermediate reentry: must contain
$f\left({\mathbf{x}}\right)$ for the current value of
x.
 3: $\mathbf{tol}$ – Real (Kind=nag_wp)Input

On initial entry: a value that controls the accuracy to which the zero is determined.
tol is used in determining the convergence of the secant iteration used at each stage of the continuation process. It is used directly when solving the last problem (
${\theta}_{m}=0$ in
Section 3), and
$\sqrt{{\mathbf{tol}}}$ is used for the problem defined by
${\theta}_{r}$,
$r<m$. Convergence to the accuracy specified by
tol is not guaranteed, and so you are recommended to find the zero using at least two values for
tol to check the accuracy obtained.
Constraint:
${\mathbf{tol}}>0.0$.
 4: $\mathbf{ir}$ – IntegerInput

On initial entry: indicates the type of error test required, as follows. Solving the problem defined by
${\theta}_{r}$,
$1\le r\le m$, involves computing a sequence of secant iterates
${x}_{r}^{0},{x}_{r}^{1},\dots \text{}$. This sequence will be considered to have converged only if:
for
${\mathbf{ir}}=0$,
for
${\mathbf{ir}}=1$,
for
${\mathbf{ir}}=2$,
for some
$i>1$; here
$\mathit{eps}$ is either
tol or
$\sqrt{{\mathbf{tol}}}$ as discussed above. Note that there are other subsidiary conditions (not given here) which must also be satisfied before the secant iteration is considered to have converged.
Constraint:
${\mathbf{ir}}=0$, $1$ or $2$.
 5: $\mathbf{scal}$ – Real (Kind=nag_wp)Input

On initial entry: a factor for use in determining a significant approximation to the derivative of
$f\left(x\right)$ at
$x={x}_{0}$, the initial value. A number of difference approximations to
${f}^{\prime}\left({x}_{0}\right)$ are calculated using
where
$\lefth\right<\left{\mathbf{scal}}\right$ and
$h$ has the same sign as
scal. A significance (cancellation) check is made on each difference approximation and the approximation is rejected if insignificant.
Suggested value:
$\sqrt{\epsilon}$, where
$\epsilon $ is the
machine precision returned by
x02ajf.
Constraint:
${\mathbf{scal}}$ must be sufficiently large that ${\mathbf{x}}+{\mathbf{scal}}\ne {\mathbf{x}}$ on the computer.
 6: $\mathbf{c}\left(26\right)$ – Real (Kind=nag_wp) arrayCommunication Array

(${\mathbf{c}}\left(5\right)$ contains the current ${\theta}_{r}$, this value may be useful in the event of an error exit.)
 7: $\mathbf{ind}$ – IntegerInput/Output

On initial entry: must be set to
$1$ or
$1$.
 ${\mathbf{ind}}=1$
 fx need not be set.
 ${\mathbf{ind}}=1$
 fx must contain $f\left({\mathbf{x}}\right)$.
On intermediate exit:
contains
$2$,
$3$ or
$4$. The calling program must evaluate
$f$ at
x, storing the result in
fx, and reenter
c05axf with all other arguments unchanged.
On final exit: contains $0$.
Constraint:
on entry ${\mathbf{ind}}=1$, $1$, $2$, $3$ or $4$.
Note: any values you return to c05axf as part of the reverse communication procedure should not include floatingpoint NaN (Not a Number) or infinity values, since these are not handled by c05axf. If your code does inadvertently return any NaNs or infinities, c05axf is likely to produce unexpected results.
 8: $\mathbf{ifail}$ – IntegerInput/Output

On initial entry:
ifail must be set to
$0$,
$1\text{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\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 arguments 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 final 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}}=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:
 ${\mathbf{ifail}}=1$

On entry, ${\mathbf{ir}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{ir}}=0$, $1$ or $2$.
On entry, ${\mathbf{tol}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{tol}}>0.0$.
 ${\mathbf{ifail}}=2$

On initial entry, ${\mathbf{ind}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{ind}}=1$ or $1$.
On intermediate entry, ${\mathbf{ind}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{ind}}=2$, $3$ or $4$.
 ${\mathbf{ifail}}=3$

On entry, ${\mathbf{scal}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{x}}+{\mathbf{scal}}\ne {\mathbf{x}}$ (to machine accuracy).
Significant derivatives of
$f$ cannot be computed. This can happen when
$f$ is almost constant and nonzero, for any value of
scal.
 ${\mathbf{ifail}}=4$

Current problem in the continuation sequence cannot be solved. Perhaps the original problem had no solution or the continuation path passes through a set of insoluble problems: consider refining the initial approximation to the zero. Alternatively,
tol is too small, and the accuracy requirement is too stringent, or too large and the initial approximation too poor.
 ${\mathbf{ifail}}=5$

Continuation away from the initial point is not possible. This error exit will usually occur if the problem has not been properly posed or the error requirement is extremely stringent.
 ${\mathbf{ifail}}=6$

Final problem (with ${\theta}_{m}=0$) cannot be solved. It is likely that too much accuracy has been requested, or that the zero is at $\alpha =0$ and ${\mathbf{ir}}=2$.
 ${\mathbf{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.
 ${\mathbf{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.
 ${\mathbf{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
The accuracy of the approximation to the zero depends on
tol and
ir. In general decreasing
tol will give more accurate results. Care must be exercised when using the relative error criterion (
${\mathbf{ir}}=2$).
If the zero is at
${\mathbf{x}}=0$, or if the initial value of
x and the zero bracket the point
${\mathbf{x}}=0$, it is likely that an error exit with
${\mathbf{ifail}}={\mathbf{4}}$,
${\mathbf{5}}$ or
${\mathbf{6}}$ will occur.
It is possible to request too much or too little accuracy. Since it is not possible to achieve more than machine accuracy, a value of
${\mathbf{tol}}\ll \mathit{machineprecision}$ should not be input and may lead to an error exit with
${\mathbf{ifail}}={\mathbf{4}}$,
${\mathbf{5}}$ or
${\mathbf{6}}$. For the reasons discussed under
${\mathbf{ifail}}={\mathbf{4}}$ in
Section 6,
tol should not be taken too large, say no larger than
${\mathbf{tol}}=\text{1.0E\u22123}$.
8
Parallelism and Performance
c05axf is not threaded in any implementation.
For most problems, the time taken on each call to
c05axf will be negligible compared with the time spent evaluating
$f\left(x\right)$ between calls to
c05axf. However, the initial value of
x and the choice of
tol will clearly affect the timing. The closer that
x is to the root, the less evaluations of
$f$ required. The effect of the choice of
tol will not be large, in general, unless
tol is very small, in which case the timing will increase.
10
Example
This example calculates a zero of $x{e}^{x}$ with initial approximation ${x}_{0}=1.0$, and ${\mathbf{tol}}=\text{1.0E\u22123}$ and $\text{1.0E\u22124}$.
10.1
Program Text
Program Text (c05axfe.f90)
10.2
Program Data
None.
10.3
Program Results
Program Results (c05axfe.r)