hide long namesshow long names
hide short namesshow short names
Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

NAG Toolbox: nag_roots_withdraw_sys_func_rcomm (c05nd)

Purpose

nag_roots_withdraw_sys_func_rcomm (c05nd) is a comprehensive reverse communication function that finds a solution of a system of nonlinear equations by a modification of the Powell hybrid method.
Note: this function is scheduled to be withdrawn, please see c05nd in Advice on Replacement Calls for Withdrawn/Superseded Routines..

Syntax

[irevcm, x, fvec, diag, fjac, r, qtf, w, ifail] = c05nd(irevcm, x, fvec, ml, mu, diag, mode, fjac, r, qtf, w, 'n', n, 'xtol', xtol, 'epsfcn', epsfcn, 'factor', factor)
[irevcm, x, fvec, diag, fjac, r, qtf, w, ifail] = nag_roots_withdraw_sys_func_rcomm(irevcm, x, fvec, ml, mu, diag, mode, fjac, r, qtf, w, 'n', n, 'xtol', xtol, 'epsfcn', epsfcn, 'factor', factor)
Note: the interface to this routine has changed since earlier releases of the toolbox:
Mark 23: lr no longer an optional input parameter
.

Description

The system of equations is defined as:
fi (x1,x2,,xn) = 0 ,   i = 1, 2, , n .
fi (x1,x2,,xn) = 0 ,   i= 1, 2, , n .
nag_roots_withdraw_sys_func_rcomm (c05nd) is based on the MINPACK routine HYBRD (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).

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

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 parameter irevcm. Between intermediate exits and re-entries, all parameters other than fvec must remain unchanged.

Compulsory Input Parameters

1:     irevcm – int64int32nag_int scalar
On initial entry: must have the value 00.
Constraint: irevcm = 0irevcm=0, 11 or 22.
2:     x(n) – double array
n, the dimension of the array, must satisfy the constraint n > 0 n>0 .
On initial entry: an initial guess at the solution vector.
3:     fvec(n) – double array
n, the dimension of the array, must satisfy the constraint n > 0 n>0 .
On initial entry: need not be set.
n, the dimension of the array, must satisfy the constraint n > 0 n>0 .
On intermediate re-entry: if irevcm = 1 irevcm=1 , fvec must not be changed.
If irevcm = 2 irevcm=2 , fvec must be set to the values of the functions computed at the current point x.
4:     ml – int64int32nag_int scalar
On initial entry: the number of subdiagonals within the band of the Jacobian matrix. (If the Jacobian is not banded, or you are unsure, set ml = n1 ml=n-1 .)
Constraint: ml0 ml0 .
5:     mu – int64int32nag_int scalar
On initial entry: the number of superdiagonals within the band of the Jacobian matrix. (If the Jacobian is not banded, or you are unsure, set mu = n1 mu=n-1 .)
Constraint: mu0 mu0 .
6:     diag(n) – double array
n, the dimension of the array, must satisfy the constraint n > 0 n>0 .
On initial entry: if mode = 2mode=2, diag must contain multiplicative scale factors for the variables.
Constraint: diag(i) > 0.0 diagi>0.0 , for i = 1,2,,ni=1,2,,n.
7:     mode – int64int32nag_int scalar
On initial entry: indicates whether or not you have provided scaling factors in diag.
If mode = 2mode=2 the scaling must have been supplied in diag.
Otherwise, the variables will be scaled internally.
8:     fjac(ldfjac,n) – double array
ldfjac, the first dimension of the array, must satisfy the constraint ldfjacn ldfjacn .
On initial entry: need not be set.
9:     r(n × (n + 1) / 2n×(n+1)/2) – double array
On initial entry: need not be set.
10:   qtf(n) – double array
n, the dimension of the array, must satisfy the constraint n > 0 n>0 .
On initial entry: need not be set.
11:   w(n,44) – double array

Optional Input Parameters

1:     n – int64int32nag_int scalar
Default: The dimension of the arrays x, fvec, diag, qtf and the first dimension of the arrays w, fjac and the second dimension of the array fjac. (An error is raised if these dimensions are not equal.)
On initial entry: nn, the number of equations.
Constraint: n > 0 n>0 .
2:     xtol – double scalar
On initial entry: the accuracy in x to which the solution is required.
Suggested value: sqrt(ε)ε, where εε is the machine precision returned by nag_machine_precision (x02aj).
Default: sqrt(machine precision) machine precision
Constraint: xtol0.0 xtol0.0 .
3:     epsfcn – double scalar
On initial entry: the order of the largest relative error in the functions. It is used in determining a suitable step for a forward difference approximation to the Jacobian. If epsfcn is less than machine precision (returned by nag_machine_precision (x02aj)) then machine precision is used. Consequently a value of 0.00.0 will often be suitable.
Default: 0.00.0
4:     factor – double scalar
On initial entry: a quantity to be used in determining the initial step bound. In most cases, factor should lie between 0.10.1 and 100.0100.0. (The step bound is factor × diag × x2 factor×diag×x2  if this is nonzero; otherwise the bound is factor.)
Default: 100.0100.0
Constraint: factor > 0.0 factor>0.0 .

Input Parameters Omitted from the MATLAB Interface

ldfjac

Output Parameters

1:     irevcm – int64int32nag_int scalar
On intermediate exit: specifies what action you must take before re-entering nag_roots_withdraw_sys_func_rcomm (c05nd) with irevcm unchanged. The value of irevcm should be interpreted as follows:
irevcm = 1 irevcm=1
Indicates the start of a new iteration. No action is required by you, but x and fvec are available for printing.
irevcm = 2 irevcm=2
Indicates that before re-entry to nag_roots_withdraw_sys_func_rcomm (c05nd), fvec must contain the function values fi(x) fi(x) .
On final exit: irevcm = 0 irevcm=0 , and the algorithm has terminated.
2:     x(n) – double array
On intermediate exit: contains the current point.
On final exit: the final estimate of the solution vector.
3:     fvec(n) – double array
On final exit: the function values at the final point, x.
4:     diag(n) – double array
On intermediate exit: the scale factors actually used (computed internally if mode2mode2).
5:     fjac(ldfjac,n) – double array
ldfjacn ldfjacn .
On intermediate exit: must not be changed.
ldfjacn ldfjacn .
On final exit: the orthogonal matrix QQ produced by the QR QR  factorization of the final approximate Jacobian.
6:     r(n × (n + 1) / 2n×(n+1)/2) – double array
On intermediate exit: must not be changed.
On final exit: the upper triangular matrix RR produced by the QR QR  factorization of the final approximate Jacobian, stored row-wise.
7:     qtf(n) – double array
On intermediate exit: must not be changed.
On final exit: the vector QTf QTf .
8:     w(n,44) – double array
9:     ifail – int64int32nag_int scalar
ifail = 0ifail=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.

  ifail = 1ifail=1
On entry, n0 n0 ,
or xtol < 0.0 xtol<0.0 ,
or ml < 0 ml<0 ,
or mu < 0 mu<0 ,
or factor0.0 factor0.0 ,
or ldfjac < n ldfjac<n ,
or mode = 2 mode=2  and diag(i)0.0 diagi0.0  for some ii, i = 1, 2, , n i= 1, 2, , n .
  ifail = 2ifail=2
On entry, irevcm < 0 irevcm<0  or irevcm > 2 irevcm>2 .
W ifail = 3ifail=3
No further improvement in the approximate solution x is possible; xtol is too small.
W ifail = 4ifail=4
The iteration is not making good progress, as measured by the improvement from the last five Jacobian evaluations.
W ifail = 5ifail=5
The iteration is not making good progress, as measured by the improvement from the last ten iterations.
A value of ifail = 4ifail=4 or 55 may indicate that the system does not have a zero, or that the solution is very close to the origin (see Section [Accuracy]). Otherwise, rerunning nag_roots_withdraw_sys_func_rcomm (c05nd) from a different starting point may avoid the region of difficulty.

Accuracy

If x^  is the true solution and DD denotes the diagonal matrix whose entries are defined by the array diag, then nag_roots_withdraw_sys_func_rcomm (c05nd) tries to ensure that
D(x)2 xtol × D2 .
D (x-x^) 2 xtol × D x^ 2 .
If this condition is satisfied with xtol = 10k xtol = 10-k , then the larger components of Dx Dx  have kk significant decimal digits. There is a danger that the smaller components of Dx Dx  may have large relative errors, but the fast rate of convergence of nag_roots_withdraw_sys_func_rcomm (c05nd) 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 function exits with ifail = 3ifail=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 test assumes that the functions are reasonably well behaved. If this condition is not satisfied, then nag_roots_withdraw_sys_func_rcomm (c05nd) may incorrectly indicate convergence. The validity of the answer can be checked, for example, by rerunning nag_roots_withdraw_sys_func_rcomm (c05nd) with a lower value for xtol.

Further Comments

The time required by nag_roots_withdraw_sys_func_rcomm (c05nd) to solve a given problem depends on nn, the behaviour of the functions, the accuracy requested and the starting point. The number of arithmetic operations executed by nag_roots_withdraw_sys_func_rcomm (c05nd) to process the evaluation of functions in the main program in each exit is about 11.5 × n2 11.5×n2 . The timing of nag_roots_withdraw_sys_func_rcomm (c05nd) will be strongly influenced by the time spent in the evaluation of the functions.
Ideally the problem should be scaled so that, at the solution, the function values are of comparable magnitude.
The number of function evaluations required to evaluate the Jacobian may be reduced if you can specify ml and mu.

Example

function nag_roots_withdraw_sys_func_rcomm_example
irevcm = int64(0);
x = [-1; -1; -1; -1; -1; -1; -1; -1; -1];
fvec = zeros(9,1);
ml = int64(1);
mu = int64(1);
diag = [1; 1; 1; 1; 1; 1; 1; 1; 1];
mode = int64(2);
fjac = zeros(9,9);
r =  zeros(45,1);
qtf = zeros(9,1);
w = zeros(9, 4);
[irevcm, x, fvec, diag, fjac, r, qtt, w, ifail] = ...
    nag_roots_withdraw_sys_func_rcomm(irevcm, x, fvec, ml, mu, diag, mode, fjac, r, qtf, w);
while (irevcm > 0)
  if (irevcm == 2)
    for i=1:9
      fvec(i) = (3-2*x(i))*x(i)+1;
      if (i > 1)
        fvec(i) = fvec(i) - x(i-1);
      end
      if (i < 9)
        fvec(i) = fvec(i) - 2*x(i+1);
      end
    end
  end
  [irevcm, x, fvec, diag, fjac, r, qtf, w, ifail] = ...
    nag_roots_withdraw_sys_func_rcomm(irevcm, x, fvec, ml, mu, diag, mode, fjac, r, qtf, w);
end
 x
 

x =

   -0.5707
   -0.6816
   -0.7017
   -0.7042
   -0.7014
   -0.6919
   -0.6658
   -0.5960
   -0.4164


function c05nd_example
irevcm = int64(0);
x = [-1; -1; -1; -1; -1; -1; -1; -1; -1];
fvec = zeros(9,1);
ml = int64(1);
mu = int64(1);
diag = [1; 1; 1; 1; 1; 1; 1; 1; 1];
mode = int64(2);
fjac = zeros(9,9);
r =  zeros(45,1);
qtf = zeros(9,1);
w = zeros(9, 4);
[irevcm, x, fvec, diag, fjac, r, qtt, w, ifail] = ...
    c05nd(irevcm, x, fvec, ml, mu, diag, mode, fjac, r, qtf, w);
while (irevcm > 0)
  if (irevcm == 2)
    for i=1:9
      fvec(i) = (3-2*x(i))*x(i)+1;
      if (i > 1)
        fvec(i) = fvec(i) - x(i-1);
      end
      if (i < 9)
        fvec(i) = fvec(i) - 2*x(i+1);
      end
    end
  end
  [irevcm, x, fvec, diag, fjac, r, qtf, w, ifail] = ...
    c05nd(irevcm, x, fvec, ml, mu, diag, mode, fjac, r, qtf, w);
end
 x
 

x =

   -0.5707
   -0.6816
   -0.7017
   -0.7042
   -0.7014
   -0.6919
   -0.6658
   -0.5960
   -0.4164



PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2013