NAG FL Interface
e04gyf (lsq_uncon_quasi_deriv_easy)
1
Purpose
e04gyf is an easytouse quasiNewton algorithm for finding an unconstrained minimum of a sum of squares of $m$ nonlinear functions in $n$ variables $\left(m\ge n\right)$. First derivatives are required.
It is intended for functions which are continuous and which have continuous first and second derivatives (although it will usually work even if the derivatives have occasional discontinuities).
2
Specification
Fortran Interface
Integer, Intent (In) 
:: 
m, n, lw 
Integer, Intent (Inout) 
:: 
iuser(*), ifail 
Real (Kind=nag_wp), Intent (Inout) 
:: 
x(n), ruser(*) 
Real (Kind=nag_wp), Intent (Out) 
:: 
fsumsq, w(lw) 
External 
:: 
lsfun2 

C Header Interface
#include <nag.h>
void 
e04gyf_ (const Integer *m, const Integer *n, void (NAG_CALL *lsfun2)(const Integer *m, const Integer *n, const double xc[], double fvec[], double fjac[], const Integer *ldfjac, Integer iuser[], double ruser[]), double x[], double *fsumsq, double w[], const Integer *lw, Integer iuser[], double ruser[], Integer *ifail) 

C++ Header Interface
#include <nag.h> extern "C" {
void 
e04gyf_ (const Integer &m, const Integer &n, void (NAG_CALL *lsfun2)(const Integer &m, const Integer &n, const double xc[], double fvec[], double fjac[], const Integer &ldfjac, Integer iuser[], double ruser[]), double x[], double &fsumsq, double w[], const Integer &lw, Integer iuser[], double ruser[], Integer &ifail) 
}

The routine may be called by the names e04gyf or nagf_opt_lsq_uncon_quasi_deriv_easy.
3
Description
e04gyf is similar to the subroutine LSFDQ2 in the NPL Algorithms Library. It is applicable to problems of the form
where
$x={\left({x}_{1},{x}_{2},\dots ,{x}_{n}\right)}^{\mathrm{T}}$ and
$m\ge n$. (The functions
${f}_{i}\left(x\right)$ are often referred to as ‘residuals’.) You must supply a subroutine to evaluate the residuals and their first derivatives at any point
$x$.
Before attempting to minimize the sum of squares, the algorithm checks the subroutine for consistency. Then, from a starting point supplied by you, a sequence of points is generated which is intended to converge to a local minimum of the sum of squares. These points are generated using estimates of the curvature of $F\left(x\right)$.
4
References
Gill P E and Murray W (1978) Algorithms for the solution of the nonlinear least squares problem SIAM J. Numer. Anal. 15 977–992
5
Arguments

1:
$\mathbf{m}$ – Integer
Input

2:
$\mathbf{n}$ – Integer
Input

On entry: the number $m$ of residuals, ${f}_{i}\left(x\right)$, and the number $n$ of variables, ${x}_{j}$.
Constraint:
$1\le {\mathbf{n}}\le {\mathbf{m}}$.

3:
$\mathbf{lsfun2}$ – Subroutine, supplied by the user.
External Procedure

You must supply this routine to calculate the vector of values
${f}_{i}\left(x\right)$ and the Jacobian matrix of first derivatives
$\frac{\partial {f}_{i}}{\partial {x}_{j}}$ at any point
$x$. It should be tested separately before being used in conjunction with
e04gyf (see the
E04 Chapter Introduction).
The specification of
lsfun2 is:
Fortran Interface
Integer, Intent (In) 
:: 
m, n, ldfjac 
Integer, Intent (Inout) 
:: 
iuser(*) 
Real (Kind=nag_wp), Intent (In) 
:: 
xc(n) 
Real (Kind=nag_wp), Intent (Inout) 
:: 
fjac(ldfjac,n), ruser(*) 
Real (Kind=nag_wp), Intent (Out) 
:: 
fvec(m) 

C Header Interface
void 
lsfun2_ (const Integer *m, const Integer *n, const double xc[], double fvec[], double fjac[], const Integer *ldfjac, Integer iuser[], double ruser[]) 

C++ Header Interface
#include <nag.h> extern "C" {
void 
lsfun2_ (const Integer &m, const Integer &n, const double xc[], double fvec[], double fjac[], const Integer &ldfjac, Integer iuser[], double ruser[]) 
}

Important: the dimension declaration for
fjac must contain the variable
ldfjac, not an integer constant.

1:
$\mathbf{m}$ – Integer
Input

On entry: $m$, the numbers of residuals.

2:
$\mathbf{n}$ – Integer
Input

On entry: $n$, the numbers of variables.

3:
$\mathbf{xc}\left({\mathbf{n}}\right)$ – Real (Kind=nag_wp) array
Input

On entry: the point $x$ at which the values of the ${f}_{i}$ and the $\frac{\partial {f}_{i}}{\partial {x}_{j}}$ are required.

4:
$\mathbf{fvec}\left({\mathbf{m}}\right)$ – Real (Kind=nag_wp) array
Output

On exit: ${\mathbf{fvec}}\left(\mathit{i}\right)$ must contain the value of ${f}_{\mathit{i}}$ at the point $x$, for $\mathit{i}=1,2,\dots ,m$.

5:
$\mathbf{fjac}\left({\mathbf{ldfjac}},{\mathbf{n}}\right)$ – Real (Kind=nag_wp) array
Output

On exit: ${\mathbf{fjac}}\left(\mathit{i},\mathit{j}\right)$ must contain the value of $\frac{\partial {f}_{\mathit{i}}}{\partial {x}_{\mathit{j}}}$ at the point $x$, for $\mathit{i}=1,2,\dots ,m$ and $\mathit{j}=1,2,\dots ,n$.

6:
$\mathbf{ldfjac}$ – Integer
Input

On entry: the first dimension of the array
fjac, set to
$m$ by
e04gyf.

7:
$\mathbf{iuser}\left(*\right)$ – Integer array
User Workspace

8:
$\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) array
User Workspace

lsfun2 is called with the arguments
iuser and
ruser as supplied to
e04gyf. You should use the arrays
iuser and
ruser to supply information to
lsfun2.
lsfun2 must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
e04gyf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: lsfun2 should not return floatingpoint NaN (Not a Number) or infinity values, since these are not handled by
e04gyf. If your code inadvertently
does return any NaNs or infinities,
e04gyf is likely to produce unexpected results.

4:
$\mathbf{x}\left({\mathbf{n}}\right)$ – Real (Kind=nag_wp) array
Input/Output

On entry:
${\mathbf{x}}\left(\mathit{j}\right)$ must be set to a guess at the
$\mathit{j}$th component of the position of the minimum, for
$\mathit{j}=1,2,\dots ,n$. The routine checks the first derivatives calculated by
lsfun2 at the starting point and so is more likely to detect an error in your routine if the initial
${\mathbf{x}}\left(j\right)$ are nonzero and mutually distinct.
On exit: the lowest point found during the calculations. Thus, if ${\mathbf{ifail}}={\mathbf{0}}$ on exit, ${\mathbf{x}}\left(j\right)$ is the $j$th component of the position of the minimum.

5:
$\mathbf{fsumsq}$ – Real (Kind=nag_wp)
Output

On exit: the value of the sum of squares,
$F\left(x\right)$, corresponding to the final point stored in
x.

6:
$\mathbf{w}\left({\mathbf{lw}}\right)$ – Real (Kind=nag_wp) array
Communication Array

7:
$\mathbf{lw}$ – Integer
Input

On entry: the dimension of the array
w as declared in the (sub)program from which
e04gyf is called.
Constraints:
 if ${\mathbf{n}}>1$, ${\mathbf{lw}}\ge 8\times {\mathbf{n}}+2\times {\mathbf{n}}\times {\mathbf{n}}+2\times {\mathbf{m}}\times {\mathbf{n}}+3\times {\mathbf{m}}$;
 if ${\mathbf{n}}=1$, ${\mathbf{lw}}\ge 11+5\times {\mathbf{m}}$.

8:
$\mathbf{iuser}\left(*\right)$ – Integer array
User Workspace

9:
$\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) array
User Workspace

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

10:
$\mathbf{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
$1$ is recommended since useful values can be provided in some output arguments even when
${\mathbf{ifail}}\ne {\mathbf{0}}$ on exit.
When the value $\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On 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:
Note: in some cases e04gyf may return useful information.
If you are not satisfied with the result (e.g., because ${\mathbf{ifail}}={\mathbf{3}}$, ${\mathbf{4}}$, ${\mathbf{5}}$, ${\mathbf{6}}$, ${\mathbf{7}}$ or ${\mathbf{8}}$), it is worth restarting the calculations from a different starting point (not the point at which the failure occurred) in order to avoid the region which caused the failure. Repeated failure may indicate some defect in the formulation of the problem.
 ${\mathbf{ifail}}=1$

On entry, ${\mathbf{m}}=\u2329\mathit{\text{value}}\u232a$ and ${\mathbf{n}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{m}}\ge {\mathbf{n}}$.
On entry, ${\mathbf{n}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{n}}\ge 1$.
On entry, ${\mathbf{n}}=1$ and ${\mathbf{lw}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: if ${\mathbf{n}}=1$ then ${\mathbf{lw}}\ge 11+5\times {\mathbf{m}}$; that is, $\u2329\mathit{\text{value}}\u232a$.
On entry, ${\mathbf{n}}>1$ and ${\mathbf{lw}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: if ${\mathbf{n}}>1$ then ${\mathbf{lw}}\ge 8\times {\mathbf{n}}+2\times {{\mathbf{n}}}^{2}+2\times {\mathbf{m}}\times {\mathbf{n}}+3\times {\mathbf{m}}$; that is, $\u2329\mathit{\text{value}}\u232a$.
 ${\mathbf{ifail}}=2$

There have been
$50\times {\mathbf{n}}$ calls to
lsfun2.
The algorithm does not seem to have converged. This may be due to an awkward function or to a poor starting point, so it is worth restarting
e04gyf from the final point held in
x.
 ${\mathbf{ifail}}=3$

The conditions for a minimum have not all been satisfied, but a lower point could not be found. See
Section 7 for further information.
 ${\mathbf{ifail}}=4$

Failure in computing SVD of Jacobian matrix.
 ${\mathbf{ifail}}=5$

It is probable that a local minimum has been found, but it cannot be guaranteed.
 ${\mathbf{ifail}}=6$

It is possible that a local minimum has been found, but it cannot be guaranteed.
 ${\mathbf{ifail}}=7$

It is unlikely that a local minimum has been found.
 ${\mathbf{ifail}}=8$

It is very unlikely that a local minimum has been found.
 ${\mathbf{ifail}}=9$

It is very likely that you have made an error in forming the derivatives in
lsfun2.
 ${\mathbf{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.
 ${\mathbf{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.
 ${\mathbf{ifail}}=999$
Dynamic memory allocation failed.
See
Section 9 in the Introduction to the NAG Library FL Interface for further information.
7
Accuracy
If the problem is reasonably well scaled and a successful exit is made then, for a computer with a mantissa of $t$ decimals, one would expect to get $t/21$ decimals accuracy in the components of $x$ and between $t1$ (if $F\left(x\right)$ is of order $1$ at the minimum) and $2t2$ (if $F\left(x\right)$ is close to zero at the minimum) decimals accuracy in $F\left(x\right)$.
8
Parallelism and Performance
e04gyf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
e04gyf 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 implementationspecific information.
The number of iterations required depends on the number of variables, the number of residuals and their behaviour, and the distance of the starting point from the solution. The number of multiplications performed per iteration of
e04gyf varies, but for
$m\gg n$ is approximately
$n\times {m}^{2}+\mathit{O}\left({n}^{3}\right)$. In addition, each iteration makes at least one call of
lsfun2. So, unless the residuals and their derivatives can be evaluated very quickly, the run time will be dominated by the time spent in
lsfun2.
Ideally the problem should be scaled so that the minimum value of the sum of squares is in the range $\left(0,1\right)$ and so that at points a unit distance away from the solution the sum of squares is approximately a unit value greater than at the minimum. It is unlikely that you will be able to follow these recommendations very closely, but it is worth trying (by guesswork), as sensible scaling will reduce the difficulty of the minimization problem, so that e04gyf will take less computer time.
When the sum of squares represents the goodnessoffit of a nonlinear model to observed data, elements of the variancecovariance matrix of the estimated regression coefficients can be computed by a subsequent call to
e04ycf, using information returned in segments of the workspace array
w. See
e04ycf for further details.
10
Example
This example finds the least squares estimates of
${x}_{1}$,
${x}_{2}$ and
${x}_{3}$ in the model
using the
$15$ sets of data given in the following table.
The program uses
$\left(0.5,1.0,1.5\right)$ as the initial guess at the position of the minimum.
10.1
Program Text
10.2
Program Data
10.3
Program Results