Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

Chapter Contents
Chapter Introduction
NAG Toolbox

# NAG Toolbox: nag_roots_contfn_brent_rcomm (c05az)

## Purpose

nag_roots_contfn_brent_rcomm (c05az) locates a simple zero of a continuous function in a given interval by using Brent's method, which is a combination of nonlinear interpolation, linear extrapolation and bisection. It uses reverse communication for evaluating the function.

## Syntax

[x, y, c, ind, ifail] = c05az(x, y, fx, tolx, c, ind, 'ir', ir)
[x, y, c, ind, ifail] = nag_roots_contfn_brent_rcomm(x, y, fx, tolx, c, ind, 'ir', ir)
Note: the interface to this routine has changed since earlier releases of the toolbox:
 At Mark 23: fx is no longer an output parameter

## Description

You must supply x and y to define an initial interval $\left[a,b\right]$ containing a simple zero of the function $f\left(x\right)$ (the choice of x and y must be such that $f\left({\mathbf{x}}\right)×f\left({\mathbf{y}}\right)\le 0.0$). The function combines the methods of bisection, nonlinear interpolation and linear extrapolation (see Dahlquist and Björck (1974)), to find a sequence of sub-intervals of the initial interval such that the final interval $\left[{\mathbf{x}},{\mathbf{y}}\right]$ contains the zero and $\left|{\mathbf{x}}-{\mathbf{y}}\right|$ is less than some tolerance specified by tolx and ir (see Arguments). In fact, since the intermediate intervals $\left[{\mathbf{x}},{\mathbf{y}}\right]$ are determined only so that $f\left({\mathbf{x}}\right)×f\left({\mathbf{y}}\right)\le 0.0$, it is possible that the final interval may contain a discontinuity or a pole of $f$ (violating the requirement that $f$ be continuous). nag_roots_contfn_brent_rcomm (c05az) checks if the sign change is likely to correspond to a pole of $f$ and gives an error return in this case.
A feature of the algorithm used by this function is that unlike some other methods it guarantees convergence within about ${\left({\mathrm{log}}_{2}\left[\left(b-a\right)/\delta \right]\right)}^{2}$ function evaluations, where $\delta$ is related to the argument tolx. See Brent (1973) for more details.
nag_roots_contfn_brent_rcomm (c05az) returns to the calling program for each evaluation of $f\left(x\right)$. On each return you should set ${\mathbf{fx}}=f\left({\mathbf{x}}\right)$ and call nag_roots_contfn_brent_rcomm (c05az) again.
The function is a modified version of procedure ‘zeroin’ given by Brent (1973).

## References

Brent R P (1973) Algorithms for Minimization Without Derivatives Prentice–Hall
Bus J C P and Dekker T J (1975) Two efficient algorithms with guaranteed convergence for finding a zero of a function ACM Trans. Math. Software 1 330–345
Dahlquist G and Björck Å (1974) Numerical Methods Prentice–Hall

## Parameters

Note: this function uses reverse communication. Its use involves an initial entry, intermediate exits and re-entries, and a final exit, as indicated by the argument ind. Between intermediate exits and re-entries, all arguments other than fx must remain unchanged.

### Compulsory Input Parameters

1:     $\mathrm{x}$ – double scalar
2:     $\mathrm{y}$ – double scalar
On initial entry: x and y must define an initial interval $\left[a,b\right]$ containing the zero, such that $f\left({\mathbf{x}}\right)×f\left({\mathbf{y}}\right)\le 0.0$. It is not necessary that ${\mathbf{x}}<{\mathbf{y}}$.
3:     $\mathrm{fx}$ – double scalar
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 re-entry: must contain $f\left({\mathbf{x}}\right)$ for the current value of x.
4:     $\mathrm{tolx}$ – double scalar
On initial entry: the accuracy to which the zero is required. The type of error test is specified by ir.
Constraint: ${\mathbf{tolx}}>0.0$.
5:     $\mathrm{c}\left(17\right)$ – double array
On initial entry: if ${\mathbf{ind}}=1$, no elements of c need be set.
If ${\mathbf{ind}}=-1$, ${\mathbf{c}}\left(1\right)$ must contain $f\left({\mathbf{y}}\right)$, other elements of c need not be set.
6:     $\mathrm{ind}$int64int32nag_int scalar
On initial entry: must be set to $1$ or $-1$.
${\mathbf{ind}}=1$
fx and ${\mathbf{c}}\left(1\right)$ need not be set.
${\mathbf{ind}}=-1$
fx and ${\mathbf{c}}\left(1\right)$ must contain $f\left({\mathbf{x}}\right)$ and $f\left({\mathbf{y}}\right)$ respectively.
Constraint: on entry ${\mathbf{ind}}=-1$, $1$, $2$, $3$ or $4$.

### Optional Input Parameters

1:     $\mathrm{ir}$int64int32nag_int scalar
Default: $0$
On initial entry: indicates the type of error test.
${\mathbf{ir}}=0$
The test is: $\left|{\mathbf{x}}-{\mathbf{y}}\right|\le 2.0×{\mathbf{tolx}}×\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1.0,\left|{\mathbf{x}}\right|\right)$.
${\mathbf{ir}}=1$
The test is: $\left|{\mathbf{x}}-{\mathbf{y}}\right|\le 2.0×{\mathbf{tolx}}$.
${\mathbf{ir}}=2$
The test is: $\left|{\mathbf{x}}-{\mathbf{y}}\right|\le 2.0×{\mathbf{tolx}}×\left|{\mathbf{x}}\right|$.
Constraint: ${\mathbf{ir}}=0$, $1$ or $2$.

### Output Parameters

1:     $\mathrm{x}$ – double scalar
2:     $\mathrm{y}$ – double scalar
On intermediate exit: x contains the point at which $f$ must be evaluated before re-entry to the function.
On final exit: x and y define a smaller interval containing the zero, such that $f\left({\mathbf{x}}\right)×f\left({\mathbf{y}}\right)\le 0.0$, and $\left|{\mathbf{x}}-{\mathbf{y}}\right|$ satisfies the accuracy specified by tolx and ir, unless an error has occurred. If ${\mathbf{ifail}}={\mathbf{4}}$, x and y generally contain very good approximations to a pole; if ${\mathbf{ifail}}={\mathbf{5}}$, x and y generally contain very good approximations to the zero (see Error Indicators and Warnings). If a point x is found such that $f\left({\mathbf{x}}\right)=0.0$, then on final exit ${\mathbf{x}}={\mathbf{y}}$ (in this case there is no guarantee that x is a simple zero). In all cases, the value returned in x is the better approximation to the zero.
3:     $\mathrm{c}\left(17\right)$ – double array
On final exit: is undefined.
4:     $\mathrm{ind}$int64int32nag_int scalar
On intermediate exit: contains $2$, $3$ or $4$. The calling program must evaluate $f$ at x, storing the result in fx, and re-enter nag_roots_contfn_brent_rcomm (c05az) with all other arguments unchanged.
On final exit: contains $0$.
5:     $\mathrm{ifail}$int64int32nag_int scalar
On final exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the function detects an error (see Error Indicators and Warnings).

## Error Indicators and Warnings

Errors or warnings detected by the function:

Cases prefixed with W are classified as warnings and do not generate an error of type NAG:error_n. See nag_issue_warnings.

${\mathbf{ifail}}=1$
On entry, $f\left({\mathbf{x}}\right)$ and $f\left({\mathbf{y}}\right)$ have the same sign with neither equalling $0.0$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{ind}}\ne -1$, $1$, $2$, $3$ or $4$.
${\mathbf{ifail}}=3$
 On entry, ${\mathbf{tolx}}\le 0.0$, or ${\mathbf{ir}}\ne 0$, $1$ or $2$.
W  ${\mathbf{ifail}}=4$
An interval $\left[{\mathbf{x}},{\mathbf{y}}\right]$ has been determined satisfying the error tolerance specified by tolx and ir and such that $f\left({\mathbf{x}}\right)×f\left({\mathbf{y}}\right)\le 0$. However, from observation of the values of $f$ during the calculation of $\left[{\mathbf{x}},{\mathbf{y}}\right]$, it seems that the interval $\left[{\mathbf{x}},{\mathbf{y}}\right]$ contains a pole rather than a zero. Note that this error exit is not completely reliable: the error exit may be taken in extreme cases when $\left[{\mathbf{x}},{\mathbf{y}}\right]$ contains a zero, or the error exit may not be taken when $\left[{\mathbf{x}},{\mathbf{y}}\right]$ contains a pole. Both these cases occur most frequently when tolx is large.
W  ${\mathbf{ifail}}=5$
The tolerance tolx is too small for the problem being solved. This indicator is only set when the interval containing the zero has been reduced to one of relative length at most $2\epsilon$, where $\epsilon$ is the machine precision, but the exit condition specified by ir is not satisfied. It is unsafe to continue reducing the interval beyond this point, but the final values of x and y returned are accurate approximations to the zero.
${\mathbf{ifail}}=-99$
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.

## Accuracy

The accuracy of the final value x as an approximation of the zero is determined by tolx and ir (see Arguments). A relative accuracy criterion (${\mathbf{ir}}=2$) should not be used when the initial values x and y are of different orders of magnitude. In this case a change of origin of the independent variable may be appropriate. For example, if the initial interval $\left[{\mathbf{x}},{\mathbf{y}}\right]$ is transformed linearly to the interval $\left[1,2\right]$, then the zero can be determined to a precise number of figures using an absolute (${\mathbf{ir}}=1$) or relative (${\mathbf{ir}}=2$) error test and the effect of the transformation back to the original interval can also be determined. Except for the accuracy check, such a transformation has no effect on the calculation of the zero.

For most problems, the time taken on each call to nag_roots_contfn_brent_rcomm (c05az) will be negligible compared with the time spent evaluating $f\left(x\right)$ between calls to nag_roots_contfn_brent_rcomm (c05az).
If the calculation terminates because $f\left({\mathbf{x}}\right)=0.0$, then on return y is set to x. (In fact, ${\mathbf{y}}={\mathbf{x}}$ on return only in this case and, possibly, when ${\mathbf{ifail}}={\mathbf{5}}$.) There is no guarantee that the value returned in x corresponds to a simple root and you should check whether it does. One way to check this is to compute the derivative of $f$ at the point x, preferably analytically, or, if this is not possible, numerically, perhaps by using a central difference estimate. If ${f}^{\prime }\left({\mathbf{x}}\right)=0.0$, then x must correspond to a multiple zero of $f$ rather than a simple zero.

## Example

This example calculates a zero of ${e}^{-x}-x$ with an initial interval $\left[0,1\right]$, ${\mathbf{tolx}}=\text{1.0e−5}$ and a mixed error test.
```function c05az_example

fprintf('c05az example results\n\n');

x = 0;
y = 1;
fx = 0;
tolx = 1e-05;
c = zeros(17,1);
ind = int64(1);
while (ind ~= 0)
[x, y, c, ind, ifail] = c05az(x, y, fx, tolx, c, ind);
fx = exp(-x) - x;
fprintf('x = %8.5f fx = %12.4e ind = %d\n', x, fx, ind);
end
if ifail == 0
fprintf('\nSolution: x = %8.5f y = %8.5f\n', x, y);
elseif ifail == 4 || ifail == 5
fprintf('\nx = %8.5f y = %8.5f\n', x, y);
end

```
```c05az example results

x =  0.00000 fx =   1.0000e+00 ind = 2
x =  1.00000 fx =  -6.3212e-01 ind = 3
x =  0.61270 fx =  -7.0814e-02 ind = 4
x =  0.56707 fx =   1.1542e-04 ind = 4
x =  0.56714 fx =  -9.4481e-07 ind = 4
x =  0.56713 fx =   1.4727e-05 ind = 4
x =  0.56714 fx =  -9.4481e-07 ind = 4
x =  0.56714 fx =  -9.4481e-07 ind = 0

Solution: x =  0.56714 y =  0.56713
```