E04YAF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

E04YAF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

E04YAF checks that a user-supplied subroutine for evaluating a vector of functions and the matrix of their first derivatives produces derivative values which are consistent with the function values calculated.

2  Specification

SUBROUTINE E04YAF ( M, N, LSQFUN, X, FVEC, FJAC, LDFJAC, IW, LIW, W, LW, IFAIL)
INTEGER  M, N, LDFJAC, IW(LIW), LIW, LW, IFAIL
REAL (KIND=nag_wp)  X(N), FVEC(M), FJAC(LDFJAC,N), W(LW)
EXTERNAL  LSQFUN

3  Description

Routines for minimizing a sum of squares of m nonlinear functions (or ‘residuals’), fix1,x2,,xn, for i=1,2,,m and mn, may require you to supply a subroutine to evaluate the fi and their first derivatives. E04YAF checks the derivatives calculated by such user-supplied subroutines, e.g., routines of the form required for E04GBF, E04GDF and E04HEF. As well as the routine to be checked (LSQFUN), you must supply a point x = x1,x2,,xnT  at which the check will be made. E04YAF is essentially identical to CHKLSJ in the NPL Algorithms Library.
E04YAF first calls LSQFUN to evaluate the fix and their first derivatives, and uses these to calculate the sum of squares Fx=i=1 m fix2, and its first derivatives gj = F x j x , for j=1,2,,n. The components of g along two orthogonal directions (defined by unit vectors p1 and p2, say) are then calculated; these will be gTp1 and gTp2 respectively. The same components are also estimated by finite differences, giving quantities
vk=Fx+hpk-Fxh,  k=1,2  
where h is a small positive scalar. If the relative difference between v1 and gTp1 or between v2 and gTp2 is judged too large, an error indicator is set.

4  References

None.

5  Arguments

1:     M – INTEGERInput
2:     N – INTEGERInput
On entry: the number m of residuals, fix, and the number n of variables, xj.
Constraint: 1NM.
3:     LSQFUN – SUBROUTINE, supplied by the user.External Procedure
LSQFUN must calculate the vector of values fix and their first derivatives fi xj  at any point x. (The minimization routines mentioned in Section 3 give you the option of resetting an argument to terminate immediately. E04YAF will also terminate immediately, without finishing the checking process, if the argument 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:     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 E04YAF, the routine will terminate immediately with IFAIL set to your setting of IFLAG.
2:     M – INTEGERInput
On entry: the numbers m of residuals.
3:     N – INTEGERInput
On entry: the numbers n of variables.
4:     XCN – REAL (KIND=nag_wp) arrayInput
On entry: x, the point at which the values of the fi and the fi xj  are required.
5:     FVECM – REAL (KIND=nag_wp) arrayOutput
On exit: unless IFLAG is reset to a negative number, FVECi must contain the value of fi at the point x, for i=1,2,,m.
6:     FJACLDFJACN – REAL (KIND=nag_wp) arrayOutput
On exit: unless IFLAG is reset to a negative number, FJACij must contain the value of fi xj  at the point x, for i=1,2,,m and j=1,2,,n.
7:     LDFJAC – INTEGERInput
On entry: the first dimension of the array FJAC as declared in the (sub)program from which E04YAF is called.
8:     IWLIW – INTEGER arrayWorkspace
9:     LIW – INTEGERInput
10:   WLW – REAL (KIND=nag_wp) arrayWorkspace
11:   LW – INTEGERInput
These arguments are present so that LSQFUN will be of the form required by the minimization routines mentioned in Section 3. LSQFUN is called with the same arguments IW, LIW, W, LW as in the call to E04YAF. If the recommendation in the minimization routine document 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 3×N+M+M×N elements of W.
LSQFUN must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which E04YAF is called. Arguments denoted as Input must not be changed by this procedure.
4:     XN – REAL (KIND=nag_wp) arrayInput
On entry: Xj, for j=1,2,,n, must be set to the coordinates of a suitable point at which to check the derivatives calculated by LSQFUN. ‘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 can go undetected. For a similar reason, it is preferable that no two elements of X should have the same value.
5:     FVECM – REAL (KIND=nag_wp) arrayOutput
On exit: unless you set IFLAG negative in the first call of LSQFUN, FVECi contains the value of fi at the point supplied by you in X, for i=1,2,,m.
6:     FJACLDFJACN – REAL (KIND=nag_wp) arrayOutput
On exit: unless you set IFLAG negative in the first call of LSQFUN, FJACij contains the value of the first derivative fi xj  at the point given in X, as calculated by LSQFUN, for i=1,2,,m and j=1,2,,n.
7:     LDFJAC – INTEGERInput
On entry: the first dimension of the array FJAC as declared in the (sub)program from which E04YAF is called.
Constraint: LDFJACM.
8:     IWLIW – INTEGER arrayCommunication Array
This array appears in the argument list purely so that, if E04YAF is called by another library routine, the library routine can pass quantities to LSQFUN via IW. IW is not examined or changed by E04YAF. In general you must provide an array IW, but are advised not to use it.
9:     LIW – INTEGERInput
On entry: the dimension of the array IW as declared in the (sub)program from which E04YAF is called.
Constraint: LIW1.
10:   WLW – REAL (KIND=nag_wp) arrayCommunication Array
11:   LW – INTEGERInput
On entry: the dimension of the array W as declared in the (sub)program from which E04YAF is called.
Constraint: LW3×N+M+M×N.
12:   IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ 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 arguments may be useful even if IFAIL0 on exit, the recommended value is -1. 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).
Note: E04YAF may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the routine:
IFAIL<0
A negative value of IFAIL indicates an exit from E04YAF because you have set IFLAG negative in LSQFUN. The setting of IFAIL will be the same as your setting of IFLAG. The check on LSQFUN will not have been completed.
IFAIL=1
On entry,M<N,
orN<1,
orLDFJAC<M,
orLIW<1,
orLW<3×N+M+M×N.
IFAIL=2
You should check carefully the derivation and programming of expressions for the fi xj , because it is very unlikely that LSQFUN is calculating them correctly.
IFAIL=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7  Accuracy

IFAIL is set to 2 if
vk - gT pk 2 h× gT pk 2 +1  
for k=1​ or ​2. (See Section 3 for definitions of the quantities involved.) The scalar h is set equal to ε, where ε is the machine precision as given by X02AJF.

8  Parallelism and Performance

E04YAF is not threaded in any implementation.

9  Further Comments

E04YAF calls LSQFUN three times.
Before using E04YAF to check the calculation of the first derivatives, you should be confident that LSQFUN is calculating the residuals correctly.
E04YAF only checks the derivatives calculated by a user-supplied routine when IFLAG=2. So, if LSQFUN is intended for use in conjunction with a minimization routine which may set IFLAG to 1, you must check that, for given settings of the XCj, LSQFUN produces the same values for the fi xj  when IFLAG is set to 1 as when IFLAG is set to 2.

10  Example

Suppose that it is intended to use E04GBF or E04GDF to find least squares estimates of x1,x2 and x3 in the model
y=x1+t1x2t2+x3t3  
using the 15 sets of data given in the following table.
y t1 t2 t3 0.14 1.0 15.0 1.0 0.18 2.0 14.0 2.0 0.22 3.0 13.0 3.0 0.25 4.0 12.0 4.0 0.29 5.0 11.0 5.0 0.32 6.0 10.0 6.0 0.35 7.0 9.0 7.0 0.39 8.0 8.0 8.0 0.37 9.0 7.0 7.0 0.58 10.0 6.0 6.0 0.73 11.0 5.0 5.0 0.96 12.0 4.0 4.0 1.34 13.0 3.0 3.0 2.10 14.0 2.0 2.0 4.39 15.0 1.0 1.0  
The following program could be used to check the first derivatives calculated by LSQFUN. (The tests of whether IFLAG=0 or 1 in LSQFUN are present ready for when LSQFUN is called by E04GBF or E04GDF. E04YAF will always call LSQFUN with IFLAG set to 2.)

10.1  Program Text

Program Text (e04yafe.f90)

10.2  Program Data

Program Data (e04yafe.d)

10.3  Program Results

Program Results (e04yafe.r)


E04YAF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2016