naginterfaces.library.roots.contfn_​interval_​rcomm

naginterfaces.library.roots.contfn_interval_rcomm(x, fx, h, boundl, boundu, y, comm, ind)

contfn_interval_rcomm attempts to locate an interval containing a simple zero of a continuous function using a binary search. It uses reverse communication for evaluating the function.

For full information please refer to the NAG Library document for c05av

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/c05/c05avf.html

Parameters

xfloat

On initial entry: the best available approximation to the zero.

fxfloat

On initial entry: if $ind=1$, $fx$ need not be set.

If $ind=-1$, $fx$ must contain $f\left(x\right)$ for the initial value of $x$.

On intermediate entry: must contain $f\left(x\right)$ for the current value of $x$.

hfloat

On initial entry: a basic step size which is used in the binary search for an interval containing a zero. The basic step sizes $h,0.1\times h$, $0.01\times h$ and $0.001\times h$ are used in turn when searching for the zero.

boundlfloat

The lower bound for the interval of search for the zero.

boundufloat

The upper bound for the interval of search for the zero.

yfloat

On initial entry: need not be set.

commdict, communication object, modified in place

Communication structure.

On initial entry: need not be set.

indint

On initial entry: must be set to $1$ or $-1$.

$ind=1$

$fx$ need not be set.

$ind=-1$

$fx$ must contain $f\left(x\right)$.

Returns

xfloat

On intermediate exit: contains the point at which $f$ must be evaluated before re-entry to the function.

On final exit: contains one end of an interval containing the zero, the other end being in $y$, unless an error has occurred. If $errno$ = 4, $x$ and $y$ are the end points of the largest interval searched. If a zero is located exactly, its value is returned in $x$ (and in $y$).

hfloat

On final exit: is undefined.

yfloat

On final exit: contains the closest point found to the final value of $x$, such that $f\left(x\right)\times f\left(y\right)\le 0.0$. If a value $x$ is found such that $f\left(x\right)=0$, $y=x$. On final exit with $errno$ = 4, $x$ and $y$ are the end points of the largest interval searched.

c1float

On final exit: if the function exits successfully or $errno$ = 4, $c1$ is set to $f\left(y\right)$.

indint

On intermediate exit: contains $2$ or $3$. The calling program must evaluate $f$ at $x$, storing the result in $fx$, and re-enter contfn_interval_rcomm with all other arguments unchanged.

On final exit: contains $0$.

Raises

NagValueError

(errno $1$)

On entry, $boundl=⟨value⟩$ and $boundu=⟨value⟩$.

Constraint: $boundl<boundu$.

(errno $1$)

On entry, $x=⟨value⟩$, $boundl=⟨value⟩$ and $boundu=⟨value⟩$.

Constraint: $boundl\le x\le boundu$.

(errno $1$)

On entry, $x=⟨value⟩$, $h=⟨value⟩$, $boundl=⟨value⟩$ and $boundu=⟨value⟩$.

Constraint: either $x+h$ or $x-h$ must lie inside the closed interval $[boundl,boundu]$.

(errno $2$)

On entry, $x=⟨value⟩$ and $h=⟨value⟩$.

Constraint: $h$ must be sufficiently large that $x+h\ne x$ on the computer.

(errno $3$)

On entry, $ind=⟨value⟩$.

Constraint: $ind=-1$, $1$, $2$ or $3$.

Warns

NagAlgorithmicWarning

(errno $4$)

An interval containing the zero could not be found. Try restarting with modified $x$ and $h$.

Notes

You must supply an initial point $x$ and a step $h$. contfn_interval_rcomm attempts to locate a short interval $[x,y]\subset [boundl,boundu]$ containing a simple zero of $f\left(x\right)$.

(On exit we may have $x>y$; $x$ is determined as the first point encountered in a binary search where the sign of $f\left(x\right)$ differs from the sign of $f\left(x\right)$ at the initial input point $x$.) The function attempts to locate a zero of $f\left(x\right)$ using $h$, $0.1\times h$, $0.01\times h$ and $0.001\times h$ in turn as its basic step before quitting with an error exit if unsuccessful.

contfn_interval_rcomm returns to the calling program for each evaluation of $f\left(x\right)$. On each return you should set $fx=f\left(x\right)$ and call contfn_interval_rcomm again.