NAG Library Routine Document
e04dgf
(uncon_conjgrd_comp_old)
e04dga (uncon_conjgrd_comp)
Note: this routine uses optional parameters to define choices in the problem specification and in the details of the algorithm. If you wish to use default
settings for all of the optional parameters, you need only read Sections 1 to 10 of this document. If, however, you wish to reset some or all of the settings please refer to Section 11 for a detailed description of the algorithm and to Section 12 for a detailed description of the specification of the optional parameters.
1
Purpose
e04dgf/e04dga minimizes an unconstrained nonlinear function of several variables using a pre-conditioned, limited memory quasi-Newton conjugate gradient method. First derivatives (or an ‘acceptable’ finite difference approximation to them) are required. It is intended for use on large scale problems.
e04dga is a version of
e04dgf that has additional arguments in order to make it safe for use in multithreaded applications (see
Section 5). The initialization routine
e04wbf must have been called before calling
e04dga.
2
Specification
2.1
Specification for e04dgf
Fortran Interface
Subroutine e04dgf ( |
n,
objfun,
iter,
objf,
objgrd,
x,
iwork,
work,
iuser,
ruser,
ifail) |
Integer, Intent (In) | :: |
n | Integer, Intent (Inout) | :: |
iuser(*),
ifail | Integer, Intent (Out) | :: |
iter,
iwork(n+1) | Real (Kind=nag_wp), Intent (Inout) | :: |
x(n),
ruser(*) | Real (Kind=nag_wp), Intent (Out) | :: |
objf,
objgrd(n),
work(13*n) | External | :: |
objfun |
|
C Header Interface
#include nagmk26.h
void |
e04dgf_ (
const Integer *n,
void (NAG_CALL *objfun)(
Integer *mode,
const Integer *n,
const double x[],
double *objf,
double objgrd[],
const Integer *nstate,
Integer iuser[],
double ruser[]),
Integer *iter,
double *objf,
double objgrd[],
double x[],
Integer iwork[],
double work[],
Integer iuser[],
double ruser[],
Integer *ifail) |
|
2.2
Specification for e04dga
Fortran Interface
Subroutine e04dga ( |
n,
objfun,
iter,
objf,
objgrd,
x,
iwork,
work,
iuser,
ruser,
lwsav,
iwsav,
rwsav,
ifail) |
Integer, Intent (In) | :: |
n | Integer, Intent (Inout) | :: |
iuser(*),
iwsav(610),
ifail | Integer, Intent (Out) | :: |
iter,
iwork(n+1) | Real (Kind=nag_wp), Intent (Inout) | :: |
x(n),
ruser(*),
rwsav(475) | Real (Kind=nag_wp), Intent (Out) | :: |
objf,
objgrd(n),
work(13*n) | Logical, Intent (Inout) | :: |
lwsav(120) | External | :: |
objfun |
|
C Header Interface
#include nagmk26.h
void |
e04dga_ (
const Integer *n,
void (NAG_CALL *objfun)(
Integer *mode,
const Integer *n,
const double x[],
double *objf,
double objgrd[],
const Integer *nstate,
Integer iuser[],
double ruser[]),
Integer *iter,
double *objf,
double objgrd[],
double x[],
Integer iwork[],
double work[],
Integer iuser[],
double ruser[],
logical lwsav[],
Integer iwsav[],
double rwsav[],
Integer *ifail) |
|
Before calling
e04dga, or
either of the option setting routines
e04dja or
e04dka,
routine
e04wbf must be called.
The specification for
e04wbf is:
Fortran Interface
Integer, Intent (In) | :: |
lcwsav,
llwsav,
liwsav,
lrwsav | Integer, Intent (Inout) | :: |
ifail | Integer, Intent (Out) | :: |
iwsav(liwsav) | Real (Kind=nag_wp), Intent (Out) | :: |
rwsav(lrwsav) | Logical, Intent (Out) | :: |
lwsav(llwsav) | Character (*), Intent (In) | :: |
rname | Character (80), Intent (Out) | :: |
cwsav(lcwsav) |
|
C Header Interface
#include nagmk26.h
void |
e04wbf (
const char *rname,
char cwsav[],
const Integer *lcwsav,
logical lwsav[],
const Integer *llwsav,
Integer iwsav[],
const Integer *liwsav,
double rwsav[],
const Integer *lrwsav,
Integer *ifail,
const Charlen length_rname,
const Charlen length_cwsav) |
|
e04wbf should be called with
.
lcwsav,
llwsav,
liwsav and
lrwsav, the declared lengths of
cwsav,
lwsav,
iwsav and
rwsav respectively, must satisfy:
The contents of the
arrays
cwsav,
lwsav,
iwsav and
rwsav
must not be altered between calling routines
e04dga,
e04dja,
e04dka and
e04wbf.
3
Description
e04dgf/e04dga is designed to solve unconstrained minimization problems of the form
where
is an
-element vector.
You must supply an initial estimate of the solution.
For maximum reliability, it is preferable to provide all first partial derivatives. If all of the derivatives cannot be provided, you are recommended to obtain approximate values (using finite differences) by calling
e04xaf/e04xaa from within
objfun. This is illustrated in
Section 10 in
e04djf/e04dja.
The method used by
e04dgf/e04dga is described in
Section 11.
4
References
Gill P E and Murray W (1979) Conjugate-gradient methods for large-scale nonlinear optimization Technical Report SOL 79-15 Department of Operations Research, Stanford University
Gill P E, Murray W and Wright M H (1981) Practical Optimization Academic Press
5
Arguments
- 1: – IntegerInput
-
On entry: , the number of variables.
Constraint:
.
- 2: – Subroutine, supplied by the user.External Procedure
-
objfun must calculate the objective function
and possibly its gradient as well for a specified
-element vector
.
The specification of
objfun is:
Fortran Interface
Integer, Intent (In) | :: |
n,
nstate | Integer, Intent (Inout) | :: |
mode,
iuser(*) | Real (Kind=nag_wp), Intent (In) | :: |
x(n) | Real (Kind=nag_wp), Intent (Inout) | :: |
ruser(*) | Real (Kind=nag_wp), Intent (Out) | :: |
objf,
objgrd(n) |
|
- 1: – IntegerInput/Output
-
On entry: indicates which values must be assigned during each call of
objfun. Only the following values need be assigned:
- objf.
- objf and objgrd.
On exit: may be set to a negative value if you wish to terminate the solution to the current problem, and in this case
e04dgf/e04dga will terminate with
ifail set to
mode.
- 2: – IntegerInput
-
On entry: , the number of variables.
- 3: – Real (Kind=nag_wp) arrayInput
-
On entry: , the vector of variables at which the objective function and its gradient are to be evaluated.
- 4: – Real (Kind=nag_wp)Output
-
On exit: the value of the objective function at .
- 5: – Real (Kind=nag_wp) arrayOutput
-
On exit: if ,
must contain the value of evaluated at , for .
- 6: – IntegerInput
-
On entry: will be
on the first call of
objfun by
e04dgf/e04dga, and
for all subsequent calls. Thus, you may wish to test,
nstate within
objfun in order to perform certain calculations once only. For example, you may read data or initialize COMMON blocksglobal variables when
.
- 7: – Integer arrayUser Workspace
- 8: – Real (Kind=nag_wp) arrayUser Workspace
-
objfun is called with the arguments
iuser and
ruser as supplied to
e04dgf/e04dga. You should use the arrays
iuser and
ruser to supply information to
objfun.
objfun must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
e04dgf/e04dga is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: objfun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
e04dgf/e04dga. If your code inadvertently
does return any NaNs or infinities,
e04dgf/e04dga is likely to produce unexpected results.
objfun should be tested separately before being used in conjunction with
e04dgf/e04dga. See also the description of the optional parameter
Verify.
- 3: – IntegerOutput
-
On exit: the total number of iterations performed.
- 4: – Real (Kind=nag_wp)Output
-
On exit: the value of the objective function at the final iterate.
- 5: – Real (Kind=nag_wp) arrayOutput
-
On exit: the gradient of the objective function at the final iterate (or its finite difference approximation).
- 6: – Real (Kind=nag_wp) arrayInput/Output
-
On entry: an initial estimate of the solution.
On exit: the final estimate of the solution.
- 7: – Integer arrayWorkspace
- 8: – Real (Kind=nag_wp) arrayWorkspace
-
- 9: – Integer arrayUser Workspace
- 10: – Real (Kind=nag_wp) arrayUser Workspace
-
iuser and
ruser are not used by
e04dgf/e04dga, but are passed directly to
objfun and may be used to pass information to this routine.
- 11: – IntegerInput/Output
-
Note: for e04dga, ifail does not occur in this position in the argument list. See the additional arguments described below.
On entry:
ifail must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, because for this routine the values of the output arguments may be useful even if
on exit, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
e04dgf/e04dga returns with
if the following three conditions are satisfied:
(i) |
|
(ii) |
|
(iii) |
or |
where
is the value of the optional parameter
Optimality Tolerance (
) and
is the absolute error associated with computing the objective function.
For a full discussion on termination criteria see Chapter 8 of
Gill et al. (1981).
- Note: the following are additional arguments for specific use with e04dga. Users of e04dgf therefore need not read the remainder of this description.
- 11: – Logical arrayCommunication Array
- 12: – Integer arrayCommunication Array
- 13: – Real (Kind=nag_wp) arrayCommunication Array
-
The arrays
lwsav,
iwsav and
rwsav must not be altered between calls to any of the routines
e04dga,
e04dja,
e04dka or
e04wbf.
- 14: – IntegerInput/Output
-
Note: see the argument description for
ifail above.
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Note: e04dgf/e04dga may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the routine:
-
A negative value of
ifail indicates an exit from
e04dgf/e04dga because you set
in
objfun. The value of
ifail will be the same as your setting of
mode.
Not used by this routine.
Not used by this routine.
-
The limiting number of iterations (as determined by the optional parameter
Iteration Limit (
) has been reached.
If the algorithm appears to be making satisfactory progress, optional parameter
Iteration Limit may be too small. If so, increase its value and rerun
e04dgf/e04dga. If the algorithm seems to be making little or no progress, then you should check for incorrect gradients as described under
.
-
The computed upper bound on the step length taken during the linesearch was too small. A rerun with an increased value of the optional parameter
Maximum Step Length (
say) may be successful unless
(the default value), in which case the current point cannot be improved upon.
Not used by this routine.
-
The conditions for an acceptable solution (see argument
ifail in
Section 5) have not all been met, but a lower point could not be found.
If
objfun computes the objective function and its gradient correctly, then this may occur because an overly stringent accuracy has been requested, i.e., the value of the optional parameter
Optimality Tolerance (
) is too small or if
. In this case you should apply the three tests described under
to determine whether or not the final solution is acceptable. For a discussion of attainable accuracy see
Gill et al. (1981).
If many iterations have occurred in which essentially no progress has been made or
e04dgf/e04dga has failed to move from the initial point,
objfun may be incorrect. You should refer to the comments below under
and check the gradients using the optional parameter
Verify (
). Unfortunately, there may be small errors in the objective gradients that cannot be detected by the verification process. Finite difference approximations to first derivatives are catastrophically affected by even small inaccuracies.
-
The user-supplied derivatives of the objective function appear to be incorrect.
Large errors were found in the derivatives of the objective function. This value of
ifail will occur if the verification process indicated that at least one gradient element had no correct figures. You should refer to the printed output to determine which elements are suspected to be in error.
As a first step, you should check that the code for the objective values is correct – for example, by computing the function at a point where the correct value is known. However, care should be taken that the chosen point fully tests the evaluation of the function. It is remarkable how often the values or are used to test function evaluation procedures, and how often the special properties of these numbers make the test meaningless.
Special care should be used in this test if computation of the objective function involves subsidiary data communicated in COMMON storage. Although the first evaluation of the function may be correct, subsequent calculations may be in error because some of the subsidiary data has accidentally been overwritten.
Errors in programming the function may be quite subtle in that the function value is almost correct. For example, the function may not be accurate to full precision because of the inaccurate calculation of a subsidiary quantity, or the limited accuracy of data upon which the function depends. A common error on machines where numerical calculations are usually performed in double precision is to include even one single precision constant in the calculation of the function; since some compilers do not convert such constants to double precision, half the correct figures may be lost by such a seemingly trivial error.
-
The gradient
at the starting point
is ‘too small’. More precisely, the value of
is less than
, where
is the value of the optional parameter
Function Precision (
).
The problem should be rerun from a different starting point.
-
An input argument is invalid.
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.
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.
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
On successful exit (
) the accuracy of the solution will be as defined by the optional parameter
Optimality Tolerance (
).
8
Parallelism and Performance
e04dgf/e04dga 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 implementation-specific information.
To evaluate an ‘acceptable’ set of finite difference intervals using
e04xaf/e04xaa requires
function evaluations per variable for a well-scaled problem and up to
function evaluations per variable for a badly scaled problem.
10
Example
This example finds a minimum of the function
The initial point is
and
(to five figures).
The optimal solution is
and
.
The document for
e04djf/e04dja includes an example program to solve the same problem using some of the optional parameters described in
Section 12.
10.1
Program Text
Note: the following programs illustrate the use of e04dgf and e04dga.
Program Text (e04dgfe.f90)
Program Text (e04dgae.f90)
10.2
Program Data
Program Data (e04dgfe.d)
Program Data (e04dgae.d)
10.3
Program Results
Program Results (e04dgfe.r)
Program Results (e04dgae.r)
Note: the remainder of this document is intended for more advanced users. Section 11 contains a detailed description of the algorithm which may be needed in order to understand Section 12. Section 12 describes the optional parameters which may be set by calls to e04djf/e04dja and/or e04dkf/e04dka.
11
Algorithmic Details
This section contains a description of the method used by e04dgf/e04dga.
e04dgf/e04dga uses a pre-conditioned conjugate gradient method and is based upon algorithm PLMA as described in Section 4.8.3 of
Gill and Murray (1979) and
Gill et al. (1981).
The algorithm proceeds as follows:
Let
be a given starting point and let
denote the current iteration, starting with
. The iteration requires
, the gradient vector evaluated at
, the
th estimate of the minimum. At each iteration a vector
(known as the direction of search) is computed and the new estimate
is given by
where
(the step length) minimizes the function
with respect to the scalar
. A choice of initial step
is taken as
where
is a user-supplied estimate of the function value at the solution. If
is not specified, the software always chooses the unit step length for
. Subsequent step length estimates are computed using cubic interpolation with safeguards.
A quasi-Newton method can be used to compute the search direction
by updating the inverse of the approximate Hessian
and computing
The updating formula for the approximate inverse is given by
where
and
.
The method used to obtain the search direction is based upon computing
as
where
is a matrix obtained by updating the identity matrix with a limited number of quasi-Newton corrections. The storage of an
by
matrix is avoided by storing only the vectors that define the rank two corrections – hence the term ‘limited-memory’ quasi-Newton method. The precise method depends upon the number of updating vectors stored. For example, the direction obtained with the ‘one-step’ limited memory update is given by
(1) using
(2) with
equal to the identity matrix, viz.
Using a limited-memory quasi-Newton formula, such as the one above, guarantees
to be a descent direction if all the inner products
are positive for all vectors
and
used in the updating formula.
12
Optional Parameters
Several optional parameters in e04dgf/e04dga define choices in the problem specification or the algorithm logic. In order to reduce the number of formal arguments of e04dgf/e04dga these optional parameters have associated default values that are appropriate for most problems. Therefore, you need only specify those optional parameters whose values are to be different from their default values.
The remainder of this section can be skipped if you wish to use the default values for all optional parameters.
The following is a list of the optional parameters available. A full description of each optional parameter is provided in
Section 12.1.
Optional parameters may be specified by calling one, or both, of the routines
e04djf/e04dja and
e04dkf/e04dka before a call to
e04dgf/e04dga.
e04djf/e04dja reads options from an external options file, with
Begin and
End as the first and last lines respectively and each intermediate line defining a single optional parameter. For example,
Begin
Print Level = 1
End
The call
Call e04djf/e04dja (ioptns, inform)
can then be used to read the file on unit
ioptns.
inform will be zero on successful exit.
e04djf/e04dja should be consulted for a full description of this method of supplying optional parameters.
e04dkf/e04dka can be called to supply options directly, one call being necessary for each optional parameter. For example,
Call e04dkf/e04dka ('Print Level = 1')
e04dkf/e04dka should be consulted for a full description of this method of supplying optional parameters.
All optional parameters not specified by you are set to their default values. Optional parameters specified by you are unaltered by e04dgf/e04dga (unless they define invalid values) and so remain in effect for subsequent calls unless altered by you.
12.1
Description of the Optional Parameters
For each option, we give a summary line, a description of the optional parameter and details of constraints.
The summary line contains:
- the keywords, where the minimum abbreviation of each keyword is underlined (if no characters of an optional qualifier are underlined, the qualifier may be omitted);
- a parameter value,
where the letters , and denote options that take character, integer and real values respectively;
- the default value, where the symbol is a generic notation for machine precision (see x02ajf), and denotes the relative precision of the objective function Function Precision.
Keywords and character values are case and white space insensitive.
This special keyword may be used to reset all optional parameters to their default values.
Estimated Optimal Function Value | | |
This value of
specifies the user-supplied guess of the optimum objective function value
. This value is used to calculate an initial step length
(see
Section 11). If the value of
is not specified (the default), then this has the effect of setting
to unity. It should be noted that for badly scaled functions a unit step along the steepest descent direction will often compute the objective function at very large values of
.
Function Precision | | Default |
The parameter defines , which is intended to be a measure of the accuracy with which the problem function can be computed. If or , the default value is used.
The value of
should reflect the relative precision of
; i.e.,
acts as a relative precision when
is large, and as an absolute precision when
is small. For example, if
is typically of order
and the first six significant digits are known to be correct, an appropriate value for
would be
. In contrast, if
is typically of order
and the first six significant digits are known to be correct, an appropriate value for
would be
. The choice of
can be quite complicated for badly scaled problems; see Chapter 8 of
Gill et al. (1981) for a discussion of scaling techniques. The default value is appropriate for most simple functions that are computed with full accuracy. However when the accuracy of the computed function values is known to be significantly worse than full precision, the value of
should be large enough so that no attempt will be made to distinguish between function values that differ by less than the error inherent in the calculation.
Iteration Limit | | Default |
The value of specifies the maximum number of iterations allowed before termination. If , the default value is used.
Problems whose Hessian matrices at the solution contain sets of clustered eigenvalues are likely to be minimized in significantly fewer than iterations. Problems without this property may require anything between and iterations, with approximately iterations being a common figure for moderately difficult problems.
Linesearch Tolerance | | Default |
The value controls the accuracy with which the step taken during each iteration approximates a minimum of the function along the search direction (the smaller the value of , the more accurate the linesearch). The default value requests an inaccurate search, and is appropriate for most problems. A more accurate search may be appropriate when it is desirable to reduce the number of iterations – for example, if the objective function is cheap to evaluate. If or , the default value is used.
List | | Default for e04dgf |
Nolist | | Default for e04dga |
Normally each optional parameter specification is printed as it is supplied. Optional parameter
Nolist may be used to suppress the printing and optional parameter
List may be used to restore printing.
Maximum Step Length | | Default |
If , the maximum allowable step length for the linesearch is taken as . If , the default value is used.
Optimality Tolerance | | Default |
The parameter
specifies the accuracy to which you wish the final iterate to approximate a solution of the problem. Broadly speaking,
indicates the number of correct figures desired in the objective function at the solution. For example, if
is
and termination occurs with
(see
Section 5), then the final point satisfies the termination criteria, where
represents
Optimality Tolerance. If
or
, the default value is used. If
Optimality Tolerance is chosen below a certain threshold, it will automatically be reset to another value.
Print Level | | Default for e04dgf
Default for e04dga
|
The value
controls the amount of printout produced by
e04dgf/e04dga, as indicated below. A detailed description of the printout is given in
Section 12.2 (summary output at each iteration and the final solution).
|
Output |
|
No output. |
|
The final solution only. |
|
One line of summary output ( characters; see Section 12.2) for each iteration (no printout of the final solution). |
|
The final solution and one line of summary output for each iteration. |
Start Objective Check at Variable | | Default |
Stop Objective Check at Variable | | Default |
These keywords take effect only if
. They may be used to control the verification of gradient elements computed by
objfun. For example, if the first
elements of the objective gradient appeared to be correct in an earlier run, so that only element
remains questionable, it is reasonable to specify
. If the first
variables appear linearly in the objective, so that the corresponding gradient elements are constant, the above choice would also be appropriate.
If or , the default value is used. If or , the default value is used.
Verify Objective Gradients | | |
These keywords refer to finite difference checks on the gradient elements computed by
objfun. Gradients are verified at the user-supplied initial estimate of the solution. The possible choices for
are as follows:
|
Meaning |
|
No checks are performed. |
|
Only a ‘cheap’ test will be performed, requiring one call to objfun. |
|
In addition to the ‘cheap’ test, individual gradient elements will also be checked using a reliable (but more expensive) test. |
For example, the objective gradient will be verified if
Verify,
,
Verify Gradients,
Verify Objective Gradients or
is specified.
This section describes the intermediate printout and final printout produced by
e04dgf/e04dga. You can control the level of printed output (see the description of the optional parameter
Print Level). Note that the intermediate printout and final printout are produced only if
(the default
for
e04dgf, by default no output is produced by
e04dga).
The following line of summary output (
characters) is produced at every iteration. In all cases, the values of the quantities are those in effect
on completion of the given iteration.
Itn |
is the iteration count.
|
Step |
is the step taken along the computed search direction. On reasonably well-behaved problems, the unit step (i.e., ) will be taken as the solution is approached.
|
Nfun |
is the cumulated number of evaluations of the objective function needed for the linesearch. Evaluations needed for the verification of the gradients by finite differences are not included. Nfun is printed as a guide to the amount of work required for the linesearch. e04dgf/e04dga will perform at most function evaluations per iteration.
|
Objective |
is the value of the objective function at .
|
Norm G |
is the Euclidean norm of the gradient of the objective function at .
|
Norm X |
is the Euclidean norm of .
|
Norm (X(k-1)-X(k)) |
is the Euclidean norm of .
|
The following describes the printout for each variable.
Variable |
gives the name (Varbl) and index , for of the variable.
|
Value |
is the value of the variable at the final iteration.
|
Gradient Value |
is the value of the gradient of the objective function with respect to the th variable at the final iteration.
|
Numerical values are output with a fixed number of digits; they are not guaranteed to be accurate to this precision.