NAG Library Manual, Mark 28.6

Interfaces: FL CL CPP AD PY MB

NAG FL Interface Introduction

C05 (Roots) Chapter Contents

C05 (Roots) Chapter Introduction

c05qb: FL CL CPP AD PY MB

NAG FL Interface
c05qbf (sys_func_easy)

Keyword Search:

NAG Library Manual, Mark 28.6

Interfaces: FL CL CPP AD PY MB

NAG FL Interface Introduction

C05 (Roots) Chapter Contents

C05 (Roots) Chapter Introduction

c05qb: FL CL CPP AD PY MB

▸▿ Contents

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

© The Numerical Algorithms Group Ltd. 2022

1 Purpose

c05qbf is an easy-to-use routine that finds a solution of a system of nonlinear equations by a modification of the Powell hybrid method.

2 Specification

Fortran Interface

Subroutine c05qbf (

fcn, n, x, fvec, xtol, iuser, ruser, ifail)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	iuser(*), ifail
Real (Kind=nag_wp), Intent (In)	::	xtol
Real (Kind=nag_wp), Intent (Inout)	::	x(n), ruser(*)
Real (Kind=nag_wp), Intent (Out)	::	fvec(n)
External	::	fcn

C Header Interface

#include <nag.h>

void	c05qbf_ ( void (NAG_CALL fcn)(const Integer n, const double x[], double fvec[], Integer iuser[], double ruser[], Integer iflag), const Integer n, double x[], double fvec[], const double xtol, Integer iuser[], double ruser[], Integer ifail)

The routine may be called by the names c05qbf or nagf_roots_sys_func_easy.

3 Description

The system of equations is defined as:

f_{i} (x_{1}, x_{2}, \dots, x_{n}) = 0,   ​ i = 1, 2, \dots, n .

c05qbf is based on the MINPACK routine HYBRD1 (see Moré et al. (1980)). It chooses the correction at each step as a convex combination of the Newton and scaled gradient directions. The Jacobian is updated by the rank-1 method of Broyden. At the starting point, the Jacobian is approximated by forward differences, but these are not used again until the rank-1 method fails to produce satisfactory progress. For more details see Powell (1970).

4 References

Moré J J, Garbow B S and Hillstrom K E (1980) User guide for MINPACK-1 Technical Report ANL-80-74 Argonne National Laboratory

Powell M J D (1970) A hybrid method for nonlinear algebraic equations Numerical Methods for Nonlinear Algebraic Equations (ed P Rabinowitz) Gordon and Breach

5 Arguments

1: $fcn$ – Subroutine, supplied by the user. External Procedure

fcn must return the values of the functions

f_{i}

at a point

x

.

The specification of fcn is:

Fortran Interface

Subroutine fcn (

n, x, fvec, iuser, ruser, iflag)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	iuser(*), iflag
Real (Kind=nag_wp), Intent (In)	::	x(n)
Real (Kind=nag_wp), Intent (Inout)	::	ruser(*)
Real (Kind=nag_wp), Intent (Out)	::	fvec(n)

C Header Interface

void	fcn (const Integer n, const double x[], double fvec[], Integer iuser[], double ruser[], Integer iflag)

1: $n$ – Integer Input: On entry: $n$ , the number of equations.
2: $x (n)$ – Real (Kind=nag_wp) array Input: On entry: the components of the point $x$ at which the functions must be evaluated.
3: $fvec (n)$ – Real (Kind=nag_wp) array Output: On exit: the function values $f_{i} (x)$ .
4: $iuser (*)$ – Integer array User Workspace
5: $ruser (*)$ – Real (Kind=nag_wp) array User Workspace: fcn is called with the arguments iuser and ruser as supplied to c05qbf. You should use the arrays iuser and ruser to supply information to fcn.
6: $iflag$ – Integer Input/Output: On entry: $iflag > 0$ .

On exit: in general, iflag should not be reset by fcn. If, however, you wish to terminate execution (perhaps because some illegal point x has been reached), iflag should be set to a negative integer.

fcn must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which c05qbf is called. Arguments denoted as Input must not be changed by this procedure.

Note: fcn should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by c05qbf. If your code inadvertently does return any NaNs or infinities, c05qbf is likely to produce unexpected results.

2: $n$ – Integer Input

On entry:

n

, the number of equations.

Constraint:

n > 0

.

3: $x (n)$ – Real (Kind=nag_wp) array Input/Output

On entry: an initial guess at the solution vector.

On exit: the final estimate of the solution vector.

4: $fvec (n)$ – Real (Kind=nag_wp) array Output

On exit: the function values at the final point returned in x.

5: $xtol$ – Real (Kind=nag_wp) Input

On entry: the accuracy in x to which the solution is required.

Suggested value:

\sqrt{ε}

, where

ε

is the machine precision returned by x02ajf.

Constraint:

xtol \geq 0.0

.

6: $iuser (*)$ – Integer array User Workspace

7: $ruser (*)$ – Real (Kind=nag_wp) array User Workspace

iuser and ruser are not used by c05qbf, but are passed directly to fcn and may be used to pass information to this routine.

8: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

,

−1

or

1

to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of

0

causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of

−1

means that an error message is printed while a value of

1

means that it is not.

If halting is not appropriate, the value

−1

or

1

is recommended. If message printing is undesirable, then the value

1

is recommended. Otherwise, the value

0

is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

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:

$ifail = 2$: There have been at least $200 \times (n + 1)$ calls to fcn. Consider restarting the calculation from the point held in x.

$ifail = 3$: No further improvement in the solution is possible. xtol is too small: $xtol = ⟨ value ⟩$ .

$ifail = 4$: The iteration is not making good progress. This failure exit may indicate that the system does not have a zero, or that the solution is very close to the origin (see Section 7). Otherwise, rerunning c05qbf from a different starting point may avoid the region of difficulty.

$ifail = 5$: Termination requested in fcn.

$ifail = 11$: On entry, $n = ⟨ value ⟩$ .
Constraint: $n > 0$ .

$ifail = 12$: On entry, $xtol = ⟨ value ⟩$ .
Constraint: $xtol \geq 0.0$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

If

\hat{x}

is the true solution, c05qbf tries to ensure that

{‖ x - \hat{x} ‖}_{2} \leq xtol \times {‖ \hat{x} ‖}_{2} .

If this condition is satisfied with

xtol = 10^{- k}

, then the larger components of

x

have

k

significant decimal digits. There is a danger that the smaller components of

x

may have large relative errors, but the fast rate of convergence of c05qbf usually obviates this possibility.

If xtol is less than machine precision and the above test is satisfied with the machine precision in place of xtol, then the routine exits with

ifail = 3

.

Note: this convergence test is based purely on relative error, and may not indicate convergence if the solution is very close to the origin.

The convergence test assumes that the functions are reasonably well behaved. If this condition is not satisfied, then c05qbf may incorrectly indicate convergence. The validity of the answer can be checked, for example, by rerunning c05qbf with a lower value for xtol.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

c05qbf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

c05qbf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

Local workspace arrays of fixed lengths are allocated internally by c05qbf. The total size of these arrays amounts to

n \times (3 \times n + 13) / 2

real elements.

The time required by c05qbf to solve a given problem depends on

n

, the behaviour of the functions, the accuracy requested and the starting point. The number of arithmetic operations executed by c05qbf to process each evaluation of the functions is approximately

11.5 \times n^{2}

. The timing of c05qbf is strongly influenced by the time spent evaluating the functions.

Ideally the problem should be scaled so that, at the solution, the function values are of comparable magnitude.

10 Example

This example determines the values

x_{1}, \dots, x_{9}

which satisfy the tridiagonal equations:

\begin{array}{rcl} (3 - 2 x_{1}) x_{1} - 2 x_{2} & = & −1, \\ - x_{i - 1} + (3 - 2 x_{i}) x_{i} - 2 x_{i + 1} & = & −1, i = 2, 3, \dots, 8 \\ - x_{8} + (3 - 2 x_{9}) x_{9} & = & −1 . \end{array}

10.1 Program Text

Program Text (c05qbfe.f90)

10.2 Program Data

None.

10.3 Program Results

Program Results (c05qbfe.r)

NAG Library Manual, Mark 28.6

Interfaces: FL CL CPP AD PY MB

NAG FL Interface Introduction

C05 (Roots) Chapter Contents

C05 (Roots) Chapter Introduction

c05qb: FL CL CPP AD PY MB

© The Numerical Algorithms Group Ltd. 2022