NAG FL Interface
e04hyf (lsq_​uncon_​mod_​deriv2_​easy)

1 Purpose

2 Specification

3 Description

4 References

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 e04hyf (see the E04 Chapter Introduction).

The specification of lsfun2 is:

Fortran Interface

Subroutine lsfun2 ( m, n, xc, fvec, fjac, ldfjac, iuser, ruser) 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(i\right)$ must be set to 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 be set to 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 as declared in the (sub)program from which e04hyf is called.

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 e04hyf. 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 e04hyf is called. Arguments denoted as Input must not be changed by this procedure.

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

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

You must supply this routine to calculate the elements of the symmetric matrix

$$B\left(x\right)=\sum _{i=1}^m{f}_i\left(x\right)G_i\left(x\right)\text{,}$$

at any point $x$, where $G_i\left(x\right)$ is the Hessian matrix of $f_i\left(x\right)$. It should be tested separately before being used in conjunction with e04hyf (see the E04 Chapter Introduction).

The specification of lshes2 is:

Fortran Interface

Subroutine lshes2 ( m, n, fvec, xc, b, lb, iuser, ruser) Integer, Intent (In) :: m, n, lb Integer, Intent (Inout) :: iuser(*) Real (Kind=nag_wp), Intent (In) :: fvec(m), xc(n) Real (Kind=nag_wp), Intent (Inout) :: ruser(*) Real (Kind=nag_wp), Intent (Out) :: b(lb)

C Header Interface

void  lshes2_ (const Integer *m, const Integer *n, const double fvec[], const double xc[], double b[], const Integer *lb, Integer iuser[], double ruser[])

C++ Header Interface

#include <nag.h> extern "C" { void  lshes2_ (const Integer &m, const Integer &n, const double fvec[], const double xc[], double b[], const Integer &lb, Integer iuser[], double ruser[]) }

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

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

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

On entry: $n$, the number of residuals.

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

On entry: the value of the residual $f_{\mathit{i}}$ at the point $x$, for $\mathit{i}=1,2,\dots ,m$, so that the values of the $f_{\mathit{i}}$ can be used in the calculation of the elements of b.

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

On entry: the point $x$ at which the elements of b are to be evaluated.

5: $\mathbf{b}\left(\mathbf{lb}\right)$ – Real (Kind=nag_wp) array Output

On exit: must contain the lower triangle of the matrix $B\left(x\right)$, evaluated at the point $x$, stored by rows. (The upper triangle is not required because the matrix is symmetric.) More precisely, $\mathbf{b}\left(\mathit{j}\left(\mathit{j}-1\right)/2+\mathit{k}\right)$ must contain ${\displaystyle \sum _{\mathit{i}=1}^m}{f}_{\mathit{i}}\frac{{\partial }^2{f}_{\mathit{i}}}{\partial x_{\mathit{j}}\partial x_{\mathit{k}}}$ evaluated at the point $x$, for $\mathit{j}=1,2,\dots ,n$ and $\mathit{k}=1,2,\dots ,\mathit{j}$.

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

On entry: the length of the array b.

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

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

lshes2 is called with the arguments iuser and ruser as supplied to e04hyf. You should use the arrays iuser and ruser to supply information to lshes2.

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

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

5: $\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 lsfun2 and lshes2 at the starting point and so is more likely to detect any error in your routines 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.

6: $\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.

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

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

On entry: the dimension of the array w as declared in the (sub)program from which e04hyf 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}$.

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

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

iuser and ruser are not used by e04hyf, but are passed directly to lsfun2 and lshes2 and may be used to pass information to these routines.

11: $\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

$\mathbf{ifail}=1$

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}\ge \mathbf{n}$.

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 1$.

On entry, $\mathbf{n}=1$ and $\mathbf{lw}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{n}=1$ then $\mathbf{lw}\ge 11+5\times \mathbf{m}$; that is, $〈\mathit{\text{value}}〉$.

On entry, $\mathbf{n}>1$ and $\mathbf{lw}=〈\mathit{\text{value}}〉$.
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, $〈\mathit{\text{value}}〉$.

$\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 e04hyf 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}=10$

It is very likely that you have made an error in setting up the array b in lshes2.

$\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

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results