NAG Library Routine Document

E04YBF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{M}$ – INTEGERInput

2:     $\mathrm{N}$ – INTEGERInput

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:     $\mathrm{LSQFUN}$ – SUBROUTINE, supplied by the user.External Procedure

LSQFUN must calculate the vector of values $f_i\left(x\right)$ and their first derivatives $\frac{\partial f_i}{\partial x_j}$ at any point $x$. (E04HEF gives you the option of resetting parameters of LSQFUN to cause the minimization process to terminate immediately. E04YBF will also terminate immediately, without finishing the checking process, if the parameter in question is reset.)

The specification of LSQFUN is:

SUBROUTINE LSQFUN ( IFLAG, M, N, XC, FVEC, FJAC, LDFJAC, IW, LIW, W, LW) INTEGER  IFLAG, M, N, LDFJAC, IW(LIW), LIW, LW REAL (KIND=nag_wp)  XC(N), FVEC(M), FJAC(LDFJAC,N), W(LW)

1:     $\mathrm{IFLAG}$ – INTEGERInput/Output

On entry: to LSQFUN, IFLAG will be set to $2$.

On exit: if you reset IFLAG to some negative number in LSQFUN and return control to E04YBF, the routine will terminate immediately with IFAIL set to your setting of IFLAG.

2:     $\mathrm{M}$ – INTEGERInput

On entry: the numbers $m$ of residuals.

3:     $\mathrm{N}$ – INTEGERInput

On entry: the numbers $n$ of variables.

4:     $\mathrm{XC}\left(\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: the point $x$ at which the values of the $f_i$ and the $\frac{\partial f_i}{\partial x_j}$ are required.

5:     $\mathrm{FVEC}\left(\mathbf{M}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: unless IFLAG is reset to a negative number, $\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$.

6:     $\mathrm{FJAC}\left(\mathbf{LDFJAC},\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: unless IFLAG is reset to a negative number, $\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$.

7:     $\mathrm{LDFJAC}$ – INTEGERInput

On entry: the first dimension of the array FJAC as declared in the (sub)program from which E04YBF is called.

8:     $\mathrm{IW}\left(\mathbf{LIW}\right)$ – INTEGER arrayWorkspace

9:     $\mathrm{LIW}$ – INTEGERInput

10:   $\mathrm{W}\left(\mathbf{LW}\right)$ – REAL (KIND=nag_wp) arrayWorkspace

11:   $\mathrm{LW}$ – INTEGERInput

These parameters are present so that LSQFUN will be of the form required by E04HEF. LSQFUN is called with E04YBF's parameters IW, LIW, W, LW as these parameters. If the recommendation in E04HEF is followed, you will have no reason to examine or change the elements of IW or W. In any case, LSQFUN must not change the first $5\times \mathbf{N}+\mathbf{M}+\mathbf{M}\times \mathbf{N}+\mathbf{N}\times \left(\mathbf{N}-1\right)/2$ (or $6+2\times \mathbf{M}$ if $\mathbf{N}=1$) elements of W.

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

Note:  E04YAF should be used to check the first derivatives calculated by LSQFUN before E04YBF is used to check the $b_{jk}$ since E04YBF assumes that the first derivatives are correct.

4:     $\mathrm{LSQHES}$ – SUBROUTINE, supplied by the user.External Procedure

LSQHES must 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)$. (As with LSQFUN, a parameter can be set to cause immediate termination.)

The specification of LSQHES is:

SUBROUTINE LSQHES ( IFLAG, M, N, FVEC, XC, B, LB, IW, LIW, W, LW) INTEGER  IFLAG, M, N, LB, IW(LIW), LIW, LW REAL (KIND=nag_wp)  FVEC(M), XC(N), B(LB), W(LW)

1:     $\mathrm{IFLAG}$ – INTEGERInput/Output

On entry: is set to a non-negative number.

On exit: if LSQHES resets IFLAG to some negative number, E04YBF will terminate immediately, with IFAIL set to your setting of IFLAG.

2:     $\mathrm{M}$ – INTEGERInput

On entry: the numbers $m$ of residuals.

3:     $\mathrm{N}$ – INTEGERInput

On entry: the numbers $n$ of variables.

4:     $\mathrm{FVEC}\left(\mathbf{M}\right)$ – REAL (KIND=nag_wp) arrayInput

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.

5:     $\mathrm{XC}\left(\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayInput

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

6:     $\mathrm{B}\left(\mathbf{LB}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: unless IFLAG is reset to a negative number B must contain the lower triangle of the matrix $B\left(x\right)$, evaluated at the point in XC, stored by rows. (The upper triangle is not needed 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}$.

7:     $\mathrm{LB}$ – INTEGERInput

On entry: gives the length of the array B.

8:     $\mathrm{IW}\left(\mathbf{LIW}\right)$ – INTEGER arrayWorkspace

9:     $\mathrm{LIW}$ – INTEGERInput

10:   $\mathrm{W}\left(\mathbf{LW}\right)$ – REAL (KIND=nag_wp) arrayWorkspace

11:   $\mathrm{LW}$ – INTEGERInput

As in LSQFUN, these parameters correspond to the parameters IW, LIW, W, LW of E04YBF. LSQHES must not change the first $5\times \mathbf{N}+\mathbf{M}\times \mathbf{N}+\mathbf{N}\times \left(\mathbf{N}-1\right)/2$ (or $6+2\times \mathbf{M}$ if $\mathbf{N}=1$) elements of W.

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

5:     $\mathrm{X}\left(\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: $\mathbf{X}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,n$, must be set to the coordinates of a suitable point at which to check the $b_{jk}$ calculated by LSQHES. ‘Obvious’ settings, such as $0$ or $1$, should not be used since, at such particular points, incorrect terms may take correct values (particularly zero), so that errors could go undetected. For a similar reason, it is preferable that no two elements of X should have the same value.

6:     $\mathrm{FVEC}\left(\mathbf{M}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: unless you set IFLAG negative in the first call of LSQFUN, $\mathbf{FVEC}\left(\mathit{i}\right)$ contains the value of $f_{\mathit{i}}$ at the point supplied by you in X, for $\mathit{i}=1,2,\dots ,m$.

7:     $\mathrm{FJAC}\left(\mathbf{LDFJAC},\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: unless you set IFLAG negative in the first call of LSQFUN, $\mathbf{FJAC}\left(\mathit{i},\mathit{j}\right)$ contains the value of the first derivative $\frac{\partial f_{\mathit{i}}}{\partial x_{\mathit{j}}}$ at the point given in X, as calculated by LSQFUN, for $\mathit{i}=1,2,\dots ,m$ and $\mathit{j}=1,2,\dots ,n$.

8:     $\mathrm{LDFJAC}$ – INTEGERInput

On entry: the first dimension of the array FJAC as declared in the (sub)program from which E04YBF is called.

Constraint: $\mathbf{LDFJAC}\ge \mathbf{M}$.

9:     $\mathrm{B}\left(\mathbf{LB}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: unless you set IFLAG negative in LSQHES, $\mathbf{B}\left(\mathit{j}\times \left(\mathit{j}-1\right)/2+\mathit{k}\right)$ contains the value of $b_{\mathit{j}\mathit{k}}$ at the point given in X as calculated by LSQHES, for $\mathit{j}=1,2,\dots ,n$ and $\mathit{k}=1,2,\dots ,\mathit{j}$.

10:   $\mathrm{LB}$ – INTEGERInput

On entry: the dimension of the array B as declared in the (sub)program from which E04YBF is called.

Constraint: $\mathbf{LB}\ge \left(\mathbf{N}+1\right)\times \mathbf{N}/2$.

11:   $\mathrm{IW}\left(\mathbf{LIW}\right)$ – INTEGER arrayWorkspace

This array appears in the parameter list purely so that, if E04YBF is called by another library routine, the library routine can pass quantities to user-supplied subroutines LSQFUN and LSQHES via IW. IW is not examined or changed by E04YBF. In general you must provide an array IW, but are advised not to use it.

12:   $\mathrm{LIW}$ – INTEGERInput

On entry: the actual length of IW as declared in the subroutine from which E04YBF is called.

Constraint: $\mathbf{LIW}\ge 1$.

13:   $\mathrm{W}\left(\mathbf{LW}\right)$ – REAL (KIND=nag_wp) arrayWorkspace

14:   $\mathrm{LW}$ – INTEGERInput

On entry: the actual length of W as declared in the subroutine from which E04YBF is called.

Constraints:

• if $\mathbf{N}>1$, $\mathbf{LW}\ge 5\times \mathbf{N}+\mathbf{M}+\mathbf{M}\times \mathbf{N}+\mathbf{N}\times \left(\mathbf{N}-1\right)/2$;
• if $\mathbf{N}=1$, $\mathbf{LW}\ge 6+2\times \mathbf{M}$.

15:   $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, because for this routine the values of the output parameters may be useful even if $\mathbf{IFAIL}\ne \mathbf{0}$ on exit, the recommended value is $-1$. When the value $-\mathbf{1}\text{ or }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}<0$

A negative value of IFAIL indicates an exit from E04YBF because you have set IFLAG negative in user-supplied subroutines LSQFUN or LSQHES. The setting of IFAIL will be the same as your setting of IFLAG. The check on LSQHES will not have been completed.

$\mathbf{IFAIL}=1$

On entry,	$\mathbf{M}<\mathbf{N}$,
or	$\mathbf{N}<1$,
or	$\mathbf{LDFJAC}<\mathbf{M}$,
or	$\mathbf{LB}<\left(\mathbf{N}+1\right)\times \mathbf{N}/2$,
or	$\mathbf{LIW}<1$,
or	$\mathbf{LW}<5\times \mathbf{N}+\mathbf{M}+\mathbf{M}\times \mathbf{N}+\mathbf{N}\times \left(\mathbf{N}-1\right)/2$, if $\mathbf{N}>1$,
or	$\mathbf{LW}<6+2\times \mathbf{M}$, if $\mathbf{N}=1$.

$\mathbf{IFAIL}=2$

You should check carefully the derivation and programming of expressions for the $b_{jk}$, because it is very unlikely that LSQHES is calculating them correctly.

$\mathbf{IFAIL}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (e04ybfe.f90)

10.2  Program Data

Program Data (e04ybfe.d)

10.3  Program Results

Program Results (e04ybfe.r)