NAG Library Function Document
nag_opt_nlin_lsq (e04unc)
1 Purpose
nag_opt_nlin_lsq (e04unc) is designed to minimize an arbitrary smooth sum of squares function subject to constraints (which may include simple bounds on the variables, linear constraints and smooth nonlinear constraints) using a sequential quadratic programming (SQP) method. As many first derivatives as possible should be supplied by you; any unspecified derivatives are approximated by finite differences. It is not intended for large sparse problems.
nag_opt_nlin_lsq (e04unc) may also be used for unconstrained, bound-constrained and linearly constrained optimization.
2 Specification
#include <nag.h> |
#include <nage04.h> |
void |
nag_opt_nlin_lsq (Integer m,
Integer n,
Integer nclin,
Integer ncnlin,
const double a[],
Integer tda,
const double bl[],
const double bu[],
const double y[],
double x[],
double *objf,
double f[],
double fjac[],
Integer tdfjac,
Nag_E04_Opt *options,
Nag_Comm *comm,
NagError *fail) |
|
3 Description
nag_opt_nlin_lsq (e04unc) is designed to solve the nonlinear least squares programming problem – the minimization of a smooth nonlinear sum of squares function subject to a set of constraints on the variables. The problem is assumed to be stated in the following form:
where
(the
objective function) is a nonlinear function which can be represented as the sum of squares of
subfunctions
, the
are constant,
is an
by
constant matrix, and
is an
element vector of nonlinear constraint functions. (The matrix
and the vector
may be empty.) The objective function and the constraint functions are assumed to be smooth, i.e., at least twice-continuously differentiable. (The method of nag_opt_nlin_lsq (e04unc) will usually solve
(1) if there are only isolated discontinuities away from the solution.)
Note that although the bounds on the variables could be included in the definition of the linear constraints, we prefer to distinguish between them for reasons of computational efficiency. For the same reason, the linear constraints should
not be included in the definition of the nonlinear constraints. Upper and lower bounds are specified for all the variables and for all the constraints. An
equality constraint can be specified by setting
. If certain bounds are not present, the associated elements of
or
can be set to special values that will be treated as
or
. (See the description of the optional argument
in
Section 12.2.)
If there are no nonlinear constraints in
(1) and
is linear or quadratic, then one of
nag_opt_lp (e04mfc),
nag_opt_lin_lsq (e04ncc) or
nag_opt_qp (e04nfc) will generally be more efficient.
You must supply an initial estimate of the solution to
(1), together with functions that define
and as many first partial derivatives as possible; unspecified derivatives are approximated by finite differences.
The subfunctions are defined by the array
y and function
objfun, and the nonlinear constraints are defined by the function
confun. On every call, these functions must return appropriate values of
and
. You should also provide the available partial derivatives. Any unspecified derivatives are approximated by finite differences; see
Section 12.2 for a discussion of the optional arguments
and
. Just before either
objfun or
confun is called, each element of the current gradient array
fjac or
conjac is initialized to a special value. On exit, any element that retains the value is estimated by finite differences. Note that if there
are any nonlinear constraints, then the
first call to
confun will precede the
first call to
objfun.
For maximum reliability, it is preferable for you to provide all partial derivatives (see Chapter 8 of
Gill et al. (1981) for a detailed discussion). If all gradients cannot be provided, it is similarly advisable to provide as many as possible. While developing the functions
objfun and
confun, the optional argument
(see
Section 12.2) should be used to check the calculation of any known gradients.
4 References
Dennis J E Jr and Moré J J (1977) Quasi-Newton methods, motivation and theory SIAM Rev. 19 46–89
Dennis J E Jr and Schnabel R B (1981) A new derivation of symmetric positive-definite secant updates nonlinear programming (eds O L Mangasarian, R R Meyer and S M Robinson) 4 167–199 Academic Press
Dennis J E Jr and Schnabel R B (1983) Numerical Methods for Unconstrained Optimization and Nonlinear Equations Prentice–Hall
Fletcher R (1987) Practical Methods of Optimization (2nd Edition) Wiley
Gill P E, Hammarling S, Murray W, Saunders M A and Wright M H (1986) Users' guide for LSSOL (Version 1.0) Report SOL 86-1 Department of Operations Research, Stanford University
Gill P E, Murray W, Saunders M A and Wright M H (1983) Documentation for FDCALC and FDCORE Technical Report SOL 83–6 Stanford University
Gill P E, Murray W, Saunders M A and Wright M H (1984) Users' Guide for SOL/QPSOL Version 3.2 Report SOL 84–5 Department of Operations Research, Stanford University
Gill P E, Murray W, Saunders M A and Wright M H (1986a) Some theoretical properties of an augmented Lagrangian merit function Report SOL 86–6R Department of Operations Research, Stanford University
Gill P E, Murray W, Saunders M A and Wright M H (1986b) Users' guide for NPSOL (Version 4.0): a Fortran package for nonlinear programming Report SOL 86-2 Department of Operations Research, Stanford University
Gill P E, Murray W and Wright M H (1981) Practical Optimization Academic Press
Hock W and Schittkowski K (1981) Test Examples for Nonlinear Programming Codes. Lecture Notes in Economics and Mathematical Systems 187 Springer–Verlag
Powell M J D (1974) Introduction to constrained optimization Numerical Methods for Constrained Optimization (eds P E Gill and W Murray) 1–28 Academic Press
Powell M J D (1983) Variable metric methods in constrained optimization Mathematical Programming: the State of the Art (eds A Bachem, M Grötschel and B Korte) 288–311 Springer–Verlag
5 Arguments
- 1:
m – IntegerInput
On entry: , the number of subfunctions associated with .
Constraint:
.
- 2:
n – IntegerInput
On entry: , the number of variables.
Constraint:
.
- 3:
nclin – IntegerInput
On entry: , the number of general linear constraints.
Constraint:
.
- 4:
ncnlin – IntegerInput
-
On entry: , the number of nonlinear constraints.
Constraint:
.
- 5:
a[] – const doubleInput
-
Note: the th element of the matrix is stored in .
On entry: the
th row of
a must contain the coefficients of the
th general linear constraint (the
th row of the matrix
in
(1)), for
.
If
then the array
a is not referenced.
- 6:
tda – IntegerInput
-
On entry: the stride separating matrix column elements in the array
a.
Constraint:
if ,
- 7:
bl[] – const doubleInput
- 8:
bu[] – const doubleInput
-
On entry:
bl must contain the lower bounds and
bu the upper bounds, for all the constraints in the following order. The first
elements of each array must contain the bounds on the variables, the next
elements the bounds for the general linear constraints (if any), and the next
elements the bounds for the nonlinear constraints (if any). To specify a nonexistent lower bound (i.e.,
), set
, and to specify a nonexistent upper bound (i.e.,
), set
, where
is one of the optional arguments (default value
, see
Section 12.2). To specify the
th constraint as an equality, set
, say, where
.
Constraints:
- , for ;
- if , .
- 9:
y[m] – const doubleInput
-
On entry: the coefficients of the constant vector in the objective function.
- 10:
objfun – function, supplied by the userExternal Function
-
objfun must calculate the vector
of subfunctions and (optionally) its Jacobian (
) for a specified
element vector
.
The specification of
objfun is:
void |
objfun (Integer m,
Integer n,
const double x[],
double f[],
double fjac[],
Integer tdfjac,
Nag_Comm *comm)
|
|
- 1:
m – IntegerInput
-
On entry: , the number of subfunctions.
- 2:
n – IntegerInput
-
On entry: , the number of variables.
- 3:
x[n] – const doubleInput
-
On entry: , the vector of variables at which and/or all available elements of its Jacobian are to be evaluated.
- 4:
f[m] – doubleOutput
-
On exit: if
or 2,
objfun must set
to the value of the
th subfunction
at the current point
, for some or all
(see the description of the argument
below).
- 5:
fjac[] – doubleOutput
-
On exit: if
,
objfun must contain the available elements of the subfunction Jacobian matrix.
must be set to the value of the first derivative
at the current point
, for
and
.
If the optional argument
(the default), all elements of
fjac must be set; if
, any available elements of the Jacobian matrix must be assigned to the elements of
fjac; the remaining elements
must remain unchanged.
Any constant elements of
fjac may be assigned once only at the first call to
objfun, i.e., when
. This is only effective if the optional argument
.
- 6:
tdfjac – IntegerInput
-
On entry: the stride separating matrix column elements in the array
fjac.
- 7:
comm – Nag_Comm*
-
Pointer to structure of type Nag_Comm; the following members are relevant to
objfun.
- flag – IntegerInput/Output
-
On entry:
objfun is called with
set to 0 or 2.
If
, then only
f is referenced.
If
, then both
f and
fjac are referenced.
On exit: if
objfun resets
to some negative number then nag_opt_nlin_lsq (e04unc) will terminate immediately with the error indicator
NE_USER_STOP. If
fail is supplied to nag_opt_nlin_lsq (e04unc),
will be set to your setting of
.
- first – Nag_BooleanInput
-
On entry: will be set to Nag_TRUE on the first call to
objfun and Nag_FALSE for all subsequent calls.
- nf – IntegerInput
-
On entry: the number of evaluations of the objective function; this value will be equal to the number of calls made to
objfun including the current one.
- needf – IntegerInput
-
On entry: if
,
objfun must set, for all
,
to the value of the
th subfunction
at the current point
. If
, for
, then it is sufficient to set
to the value of the
th subfunction
. Appropriate use of
can save a lot of computational work in some cases. Note that when
,
will always be 0, hence this does not apply to the Jacobian matrix.
- user – double *
- iuser – Integer *
- p – Pointer
-
The type Pointer will be void * with a C compiler that defines void * and char * otherwise.
Before calling nag_opt_nlin_lsq (e04unc) these pointers may be allocated memory and initialized with various quantities for use by
objfun when called from nag_opt_nlin_lsq (e04unc).
Note: objfun should be tested separately before being used in conjunction with nag_opt_nlin_lsq (e04unc). The optional arguments
and
can be used to assist this process. The array
x must
not be changed by
objfun.
If the function
objfun does not calculate all of the Jacobian elements then the optional argument
should be set to Nag_FALSE.
- 11:
confun – function, supplied by the userExternal Function
-
confun must calculate the vector
of nonlinear constraint functions and (optionally) its Jacobian (
) for a specified
element vector
. If there are no nonlinear constraints (i.e.,
),
confun will never be called and the NAG defined null void function pointer,
NULLFN, can be supplied in the call to nag_opt_nlin_lsq (e04unc). If there are nonlinear constraints the first call to
confun will occur before the first call to
objfun.
The specification of
confun is:
- 1:
n – IntegerInput
-
On entry: , the number of variables.
- 2:
ncnlin – IntegerInput
-
On entry: , the number of nonlinear constraints.
- 3:
needc[ncnlin] – const IntegerInput
-
On entry: the indices of the elements of
conf and/or
conjac that must be evaluated by
confun. If
then the
th element of
conf and/or the available elements of the
th row of
conjac (see argument
below) must be evaluated at
.
- 4:
x[n] – const doubleInput
-
On entry: the vector of variables at which the constraint functions and/or all available elements of the constraint Jacobian are to be evaluated.
- 5:
conf[ncnlin] – doubleOutput
-
On exit: if
and
or 2,
must contain the value of the
th constraint at
. The remaining elements of
conf, corresponding to the non-positive elements of
needc, are ignored.
- 6:
conjac[] – doubleOutput
-
On exit: if
and
, the
th row of
conjac (i.e., the elements
, for
) must contain the available elements of the vector
given by
where
is the partial derivative of the
th constraint with respect to the
th variable, evaluated at the point
. The remaining rows of
conjac, corresponding to non-positive elements of
needc, are ignored.
If the optional argument
(the default), all elements of
conjac must be set; if
, then any available partial derivatives of
must be assigned to the elements of
conjac; the remaining elements
must remain unchanged.
If all elements of the constraint Jacobian are known (i.e.,
; see
Section 12.2), any constant elements may be assigned to
conjac one time only at the start of the optimization. An element of
conjac that is not subsequently assigned in
confun will retain its initial value throughout. Constant elements may be loaded into
conjac during the first call to
confun. The ability to preload constants is useful when many Jacobian elements are identically zero, in which case
conjac may be initialized to zero at the first call when
.
It must be emphasized that, if
, unassigned elements of
conjac are not treated as constant; they are estimated by finite differences, at non-trivial expense. If you do not supply a value for the optional argument
(the default; see
Section 12.2), an interval for each element of
is computed automatically at the start of the optimization. The automatic procedure can usually identify constant elements of
conjac, which are then computed once only by finite differences.
- 7:
comm – Nag_Comm*
-
Pointer to structure of type Nag_Comm; the following members are relevant to
confun.
- flag – IntegerInput/Output
-
On entry:
confun is called with
set to 0 or 2.
If
, only
conf is referenced.
If
, both
conf and
conjac are referenced.
On exit: if
confun resets
to some negative number then nag_opt_nlin_lsq (e04unc) will terminate immediately with the error indicator
NE_USER_STOP. If
fail is supplied to nag_opt_nlin_lsq (e04unc),
will be set to your setting of
.
- first – Nag_BooleanInput
-
On entry: will be set to Nag_TRUE on the first call to
confun and Nag_FALSE for all subsequent calls.
- user – double *
- iuser – Integer *
- p – Pointer
-
The type Pointer will be void * with a C compiler that defines void * and char * otherwise.
Before calling nag_opt_nlin_lsq (e04unc) these pointers may be allocated memory and initialized with various quantities for use by
confun when called from nag_opt_nlin_lsq (e04unc).
Note: confun should be tested separately before being used in conjunction with nag_opt_nlin_lsq (e04unc). The optional arguments
and
can be used to assist this process. The array
x must
not be changed by
confun.
If
confun does not calculate all of the Jacobian constraint elements then the optional argument
should be set to Nag_FALSE.
- 12:
x[n] – doubleInput/Output
-
On entry: an initial estimate of the solution.
On exit: the final estimate of the solution.
- 13:
objf – double *Output
-
On exit: the value of the objective function at the final iterate.
- 14:
f[m] – doubleOutput
-
On exit: the values of the subfunctions , for , at the final iterate.
- 15:
fjac[] – doubleOutput
-
On exit: the Jacobian matrix of the functions
at the final iterate, i.e.,
contains the partial derivative of the
th subfunction with respect to the
th variable, for
and
. (See also the discussion of argument
fjac under
objfun.)
- 16:
tdfjac – IntegerInput
-
On entry: the stride separating matrix column elements in the array
fjac.
Constraint:
.
- 17:
options – Nag_E04_Opt *Input/Output
-
On entry/exit: a pointer to a structure of type Nag_E04_Opt whose members are optional arguments for nag_opt_nlin_lsq (e04unc). These structure members offer the means of adjusting some of the argument values of the algorithm and on output will supply further details of the results. A description of the members of
options is given below in
Section 12. Some of the results returned in
options can be used by nag_opt_nlin_lsq (e04unc) to perform a ‘warm start’ (see the member
in
Section 12.2).
If any of these optional arguments are required then the structure
options should be declared and initialized by a call to
nag_opt_init (e04xxc) and supplied as an argument to nag_opt_nlin_lsq (e04unc). However, if the optional arguments are not required the NAG defined null pointer,
E04_DEFAULT, can be used in the function call.
- 18:
comm – Nag_Comm *Communication Structure
-
Note: comm is a NAG defined type (see
Section 3.2.1.1 in the Essential Introduction).
On entry/exit: structure containing pointers for communication to the user-supplied functions
objfun and
confun, and the optional user-defined printing function; see the description of
objfun and
confun and
Section 12.3.1 for details. If you do not need to make use of this communication feature the null pointer
NAGCOMM_NULL may be used in the call to nag_opt_nlin_lsq (e04unc);
comm will then be declared internally for use in calls to user-supplied functions.
- 19:
fail – NagError *Input/Output
-
The NAG error argument (see
Section 3.6 in the Essential Introduction).
5.1 Description of Printed Output
Intermediate and final results are printed out by default. The level of printed output can be controlled with the structure members
and
(see
Section 12.2). The default setting of
and
provides a single line of output at each iteration and the final result. This section describes the default printout produced by nag_opt_nlin_lsq (e04unc).
The following line of summary output (
characters) is produced at every major iteration. In all cases, the values of the quantities printed are those in effect
on completion of the given iteration.
Maj |
is the major iteration count. |
Mnr |
is the number of minor iterations required by the feasibility and optimality phases of the QP subproblem. Generally, Mnr will be 1 in the later iterations, since theoretical analysis predicts that the correct active set will be identified near the solution (see Section 11). |
|
Note that Mnr may be greater than the optional argument (default value ; see Section 12.2) if some iterations are required for the feasibility phase. |
Step |
is the step taken along the computed search direction. On reasonably well-behaved problems, the unit step will be taken as the solution is approached. |
Merit function |
is the value of the augmented Lagrangian merit function at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty arguments (see Section 11.3). As the solution is approached, Merit function will converge to the value of the objective function at the solution.
If the QP subproblem does not have a feasible point (signified by I at the end of the current output line), the merit function is a large multiple of the constraint violations, weighted by the penalty arguments. During a sequence of major iterations with infeasible subproblems, the sequence of Merit Function values will decrease monotonically until either a feasible subproblem is obtained or nag_opt_nlin_lsq (e04unc) terminates with (no feasible point could be found for the nonlinear constraints).
If no nonlinear constraints are present (i.e., ), this entry contains Objective, the value of the objective function . The objective function will decrease monotonically to its optimal value when there are no nonlinear constraints. |
Violtn |
is the Euclidean norm of the residuals of constraints that are violated or in the predicted active set (not printed if ncnlin is zero). Violtn will be approximately zero in the neighbourhood of a solution. |
Norm Gz |
is , the Euclidean norm of the projected gradient (see Section 11.1). Norm Gz will be approximately zero in the neighbourhood of a solution. |
Cond Hz |
is a lower bound on the condition number of the projected Hessian approximation
; see (6) and (11). The larger this number, the more difficult the problem. |
The line of output may be terminated by one of the following characters:
M |
is printed if the quasi-Newton update was modified to ensure that the Hessian approximation is positive definite (see Section 11.4). |
I |
is printed if the QP subproblem has no feasible point. |
C |
is printed if central differences were used to compute the unspecified objective and constraint gradients. If the value of Step is zero, the switch to central differences was made because no lower point could be found in the line search. (In this case, the QP subproblem is re-solved with the central difference gradient and Jacobian.) If the value of Step is nonzero, central differences were computed because Norm Gz and Violtn imply that is close to a Kuhn–Tucker point (see Section 11.1). |
L |
is printed if the line search has produced a relative change in greater than the value defined by the optional argument (default value ; see Section 12.2). If this output occurs frequently during later iterations of the run, should be set to a larger value. |
R |
is printed if the approximate Hessian has been refactorized. If the diagonal condition estimator of indicates that the approximate Hessian is badly conditioned, the approximate Hessian is refactorized using column interchanges. If necessary, is modified so that its diagonal condition estimator is bounded. |
The final printout includes a listing of the status of every variable and constraint.
The following describes the printout for each variable.
Varbl |
gives the name (V) and index , for of the variable. |
State |
gives the state of the variable (FR if neither bound is in the active set, EQ if a fixed variable, LL if on its lower bound, UL if on its upper bound). If Value lies outside the upper or lower bounds by more than the feasibility tolerances specified by the optional arguments and (see Section 12.2), State will be ++ or -- respectively.
A key is sometimes printed before State to give some additional information about the state of a variable.
A |
Alternative optimum possible. The variable is active at one of its bounds, but its Lagrange Multiplier is essentially zero. This means that if the variable were allowed to start moving away from its bound, there would be no change to the objective function. The values of the other free variables might change, giving a genuine alternative solution. However, if there are any degenerate variables (labelled D), the actual change might prove to be zero, since one of them could encounter a bound immediately. In either case, the values of the Lagrange multipliers might also change. |
D |
Degenerate. The variable is free, but it is equal to (or very close to) one of its bounds. |
I |
Infeasible. The variable is currently violating one of its bounds by more than . |
|
Value |
is the value of the variable at the final iteration. |
Lower bound |
is the lower bound specified for the variable . (None indicates that , where is the optional argument.) |
Upper bound |
is the upper bound specified for the variable . (None indicates that , where is the optional argument.) |
Lagr Mult |
is the value of the Lagrange multiplier for the associated bound constraint. This will be zero if State is FR unless and , in which case the entry will be blank. If is optimal, the multiplier should be non-negative if State is LL, and non-positive if State is UL. |
Residual |
is the difference between the variable Value and the nearer of its (finite) bounds and . A blank entry indicates that the associated variable is not bounded (i.e., and ). |
The meaning of the printout for linear and nonlinear constraints is the same as that given above for variables, with ‘variable’ replaced by ‘constraint’,
and
are replaced by
and
respectively, and with the following changes in the heading:
L Con |
gives the name (L) and index , for of the linear constraint. |
N Con |
gives the name (N) and index , for , of the nonlinear constraint. |
The I key in the State column is printed for general linear constraints which currently violate one of their bounds by more than and for nonlinear constraints which violate one of their bounds by more than .
Note that movement off a constraint (as opposed to a variable moving away from its bound) can be interpreted as allowing the entry in the Residual column to become positive.
Numerical values are output with a fixed number of digits; they are not guaranteed to be accurate to this precision.
6 Error Indicators and Warnings
- NE_2_INT_ARG_LT
-
On entry, while . These arguments must satisfy .
This error message is output only if .
- NE_2_INT_OPT_ARG_CONS
-
On entry, while .
Constraint: .
On entry, while .
Constraint: .
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
On entry, argument had an illegal value.
On entry, argument had an illegal value.
On entry, argument had an illegal value.
On entry, argument had an illegal value.
- NE_BOUND
-
The lower bound for variable (array element ) is greater than the upper bound.
- NE_BOUND_EQ
-
The lower bound and upper bound for variable (array elements and ) are equal but they are greater than or equal to .
- NE_BOUND_EQ_LCON
-
The lower bound and upper bound for linear constraint (array elements and ) are equal but they are greater than or equal to .
- NE_BOUND_EQ_NLCON
-
The lower bound and upper bound for nonlinear constraint (array elements and ) are equal but they are greater than or equal to .
- NE_BOUND_LCON
-
The lower bound for linear constraint (array element ) is greater than the upper bound.
- NE_BOUND_NLCON
-
The lower bound for nonlinear constraint (array element ) is greater than the upper bound.
- NE_DERIV_ERRORS
-
Large errors were found in the derivatives of the objective function and/or nonlinear constraints.
This failure will occur if the verification process indicated that at least one gradient or Jacobian 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 and constraint 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.
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.
- NE_INT_ARG_LT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_OPT_ARG_GT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_OPT_ARG_LT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
- NE_INVALID_INT_RANGE_1
-
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
- NE_INVALID_REAL_RANGE_EF
-
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
- NE_INVALID_REAL_RANGE_F
-
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
- NE_INVALID_REAL_RANGE_FF
-
Value given to not valid. Correct range is .
Value given to not valid. Correct range is .
- NE_NOT_APPEND_FILE
-
Cannot open file for appending.
- NE_NOT_CLOSE_FILE
-
Cannot close file .
- NE_OPT_NOT_INIT
-
Options structure not initialized.
- NE_STATE_VAL
-
is out of range. .
- NE_USER_STOP
-
This exit occurs if you set
to a negative value in
objfun or
confun. If
fail is supplied, the value of
will be the same as your setting of
.
User requested termination, user flag value .
- NW_KT_CONDITIONS
-
The current point cannot be improved upon. The final point does not satisfy the first-order Kuhn–Tucker conditions and no improved point for the merit function could be found during the final line search.
The Kuhn–Tucker conditions are specified and the merit function described in
Sections 11.1 and
11.3.
This sometimes occurs because an overly stringent accuracy has been requested, i.e., the value of the optional argument
(default value
, where
is the relative precision of
; see
Section 12.2) is too small. In this case you should apply the four tests described in
Section 9.1 to determine whether or not the final solution is acceptable (see
Gill et al. (1981)), for a discussion of the attainable accuracy).
If many iterations have occurred in which essentially no progress has been made and nag_opt_nlin_lsq (e04unc) has failed completely to move from the initial point then functions
objfun and/or
confun may be incorrect. You should refer to comments below under
and check the gradients using the optional argument
(default value
; see
Section 12.2). Unfortunately, there may be small errors in the objective and constraint gradients that cannot be detected by the verification process. Finite difference approximations to first derivatives are catastrophically affected by even small inaccuracies. An indication of this situation is a dramatic alteration in the iterates if the finite difference interval is altered. One might also suspect this type of error if a switch is made to central differences even when
Norm Gz and
Violtn (see
Section 5.1) are large.
Another possibility is that the search direction has become inaccurate because of ill conditioning in the Hessian approximation or the matrix of constraints in the working set; either form of ill conditioning tends to be reflected in large values of
Mnr (the number of iterations required to solve each QP subproblem; see
Section 5.1).
If the condition estimate of the projected Hessian (
Cond Hz; see
Section 5.1) is extremely large, it may be worthwhile rerunning nag_opt_nlin_lsq (e04unc) from the final point with the optional argument
(see
Section 12.2). In this situation, the optional arguments
and
should be left unaltered and
(in optional argument
) should be reset to the identity matrix.
If the matrix of constraints in the working set is ill conditioned (i.e.,
Cond T is extremely large; see
Section 12.3), it may be helpful to run nag_opt_nlin_lsq (e04unc) with a relaxed value of the optional arguments
and
(default values
, and
or
, respectively, where
is the
machine precision; see
Section 12.2). (Constraint dependencies are often indicated by wide variations in size in the diagonal elements of the matrix
, whose diagonals will be printed if the optional argument
(default value
; see
Section 12.2).)
- NW_LIN_NOT_FEASIBLE
-
No feasible point was found for the linear constraints and bounds.
nag_opt_nlin_lsq (e04unc) has terminated without finding a feasible point for the linear constraints and bounds, which means that either no feasible point exists for the given value of the optional argument
(default value
, where
is the
machine precision; see
Section 12.2), or no feasible point could be found in the number of iterations specified by the optional argument
(default value
; see
Section 12.2). You should check that there are no constraint redundancies. If the data for the constraints are accurate only to an absolute precision
, you should ensure that the value of the optional argument
is greater than
. For example, if all elements of
are of order unity and are accurate to only three decimal places,
should be at least
.
- NW_NONLIN_NOT_FEASIBLE
-
No feasible point could be found for the nonlinear constraints.
The problem may have no feasible solution. This means that there has been a sequence of QP subproblems for which no feasible point could be found (indicated by
I at the end of each terse line of output; see
Section 5.1). This behaviour will occur if there is no feasible point for the nonlinear constraints. (However, there is no general test that can determine whether a feasible point exists for a set of nonlinear constraints.) If the infeasible subproblems occur from the very first major iteration, it is highly likely that no feasible point exists. If infeasibilities occur when earlier subproblems have been feasible, small constraint inconsistencies may be present. You should check the validity of constraints with negative values of the optional argument
. If you are convinced that a feasible point does exist, nag_opt_nlin_lsq (e04unc) should be restarted at a different starting point.
- NW_NOT_CONVERGED
-
Optimal solution found, but the sequence of iterates has not converged with the requested accuracy.
The final iterate
satisfies the first-order Kuhn–Tucker conditions to the accuracy requested, but the sequence of iterates has not yet converged. nag_opt_nlin_lsq (e04unc) was terminated because no further improvement could be made in the merit function (see
Section 11).
This value of
fail may occur in several circumstances. The most common situation is that you ask for a solution with accuracy that is not attainable with the given precision of the problem (as specified by the optional argument
(default value
, where
is the
machine precision; see
Section 12.2). This condition will also occur if, by chance, an iterate is an ‘exact’ Kuhn–Tucker point, but the change in the variables was significant at the previous iteration. (This situation often happens when minimizing very simple functions, such as quadratics.)
If the four conditions listed in
Section 9.1 are satisfied then
is likely to be a solution of
(1) even if
.
- NW_OVERFLOW_WARN
-
Serious ill conditioning in the working set after adding constraint
. Overflow may occur in subsequent iterations.
If overflow occurs preceded by this warning then serious ill conditioning has probably occurred in the working set when adding a constraint. It may be possible to avoid the difficulty by increasing the magnitude of the optional argument
(default value
, where
is the
machine precision; see
Section 12.2) and/or the optional argument
(default value
or
; see
Section 12.2), and rerunning the program. If the message recurs even after this change, the offending linearly dependent constraint
must be removed from the problem. If overflow occurs in one of the user-supplied functions (e.g., if the nonlinear functions involve exponentials or singularities), it may help to specify tighter bounds for some of the variables (i.e., reduce the gap between the appropriate
and
).
- NW_TOO_MANY_ITER
-
The maximum number of iterations,
, have been performed.
The value of the optional argument
may be too small. If the method appears to be making progress (e.g., the objective function is being satisfactorily reduced), increase the value of
and rerun nag_opt_nlin_lsq (e04unc); alternatively, rerun nag_opt_nlin_lsq (e04unc), setting the optional argument
to specify the initial working set. If the algorithm seems to be making little or no progress, however, then you should check for incorrect gradients or ill conditioning as described below under
.
Note that ill conditioning in the working set is sometimes resolved automatically by the algorithm, in which case performing additional iterations may be helpful. However, ill conditioning in the Hessian approximation tends to persist once it has begun, so that allowing additional iterations without altering
is usually inadvisable. If the quasi-Newton update of the Hessian approximation was reset during the latter iterations (i.e., an
R occurs at the end of each terse line; see
Section 5.1), it may be worthwhile setting
and calling nag_opt_nlin_lsq (e04unc) from the final point.
7 Accuracy
If
on exit, then the vector returned in the array
x is an estimate of the solution to an accuracy of approximately
(default value
, where
is the relative precision of
; see
Section 12.2).
8 Parallelism and Performance
Not applicable.
9.1 Termination Criteria
The function exits with
if iterates have converged to a point
that satisfies the Kuhn–Tucker conditions (see
Section 11.1) to the accuracy requested by the optional argument
(default value
, see
Section 12.2).
You should also examine the printout from nag_opt_nlin_lsq (e04unc) (see
Section 5.1) to check whether the following four conditions are satisfied:
(i) |
the final value of Norm Gz is significantly less than at the starting point; |
(ii) |
during the final major iterations, the values of Step and Mnr are both one; |
(iii) |
the last few values of both Violtn and Norm Gz become small at a fast linear rate; and |
(iv) |
Cond Hz is small. |
If all these conditions hold, is almost certainly a local minimum.
10 Example
This example is based on Problem 57 in
Hock and Schittkowski (1981) and involves the minimization of the sum of squares function
where
and
subject to the bounds
to the general linear constraint
and to the nonlinear constraint
The initial point, which is infeasible, is
and
.
The optimal solution (to five figures) is
and
. The nonlinear constraint is active at the solution.
The
options structure is declared and initialized by
nag_opt_init (e04xxc). On return from nag_opt_nlin_lsq (e04unc), the memory freeing function
nag_opt_free (e04xzc) is used to free the memory assigned to the pointers in the options structure. You must
not use the standard C function
free() for this purpose.
10.1 Program Text
Program Text (e04unce.c)
10.2 Program Data
Program Data (e04unce.d)
10.3 Program Results
Program Results (e04unce.r)
11 Further Description
This section gives a detailed description of the algorithm used in nag_opt_nlin_lsq (e04unc). This, and possibly the next section,
Section 12, may be omitted if the more sophisticated features of the algorithm and software are not currently of interest.
11.1 Overview
nag_opt_nlin_lsq (e04unc) is based on the same algorithm as used in subroutine NPSOL described in
Gill et al. (1986b).
At a solution of
(1), some of the constraints will be
active, i.e., satisfied exactly. An active simple bound constraint implies that the corresponding variable is
fixed at its bound, and hence the variables are partitioned into
fixed and
free variables. Let
denote the
by
matrix of gradients of the active general linear and nonlinear constraints. The number of fixed variables will be denoted by
, with
the number of free variables. The subscripts ‘FX’ and ‘FR’ on a vector or matrix will denote the vector or matrix composed of the elements corresponding to fixed or free variables.
A point
is a
first-order Kuhn–Tucker point for
(1) (see, e.g.,
Powell (1974)) if the following conditions hold:
(i) |
is feasible; |
(ii) |
there exist vectors and (the Lagrange multiplier vectors for the bound and general constraints) such that
where is the gradient of evaluated at , and if the th variable is free. |
(iii) |
The Lagrange multiplier corresponding to an inequality constraint active at its lower bound must be non-negative, and it must be non-positive for an inequality constraint active at its upper bound. |
Let
denote a matrix whose columns form a basis for the set of vectors orthogonal to the rows of
; i.e.,
. An equivalent statement of the condition
(2) in terms of
is
The vector
is termed the
projected gradient of
at
. Certain additional conditions must be satisfied in order for a first-order Kuhn–Tucker point to be a solution of
(1) (see, e.g.,
Powell (1974)). nag_opt_nlin_lsq (e04unc) implements a sequential quadratic programming (SQP) method. For an overview of SQP methods, see, for example,
Fletcher (1987),
Gill et al. (1981) and
Powell (1983).
The basic structure of nag_opt_nlin_lsq (e04unc) involves
major and
minor iterations. The major iterations generate a sequence of iterates
that converge to
, a first-order Kuhn–Tucker point of
(1). At a typical major iteration, the new iterate
is defined by
where
is the current iterate, the non-negative scalar
is the
step length, and
is the
search direction. (For simplicity, we shall always consider a typical iteration and avoid reference to the index of the iteration.) Also associated with each major iteration are estimates of the Lagrange multipliers and a prediction of the active set.
The search direction
in
(3) is the solution of a quadratic programming subproblem of the form
where
is the gradient of
at
, the matrix
is a positive definite quasi-Newton approximation to the Hessian of the Lagrangian function (see
Section 11.4), and
is the Jacobian matrix of
evaluated at
. (Finite difference estimates may be used for
and
; see the optional arguments
and
in
Section 12.2.) Let
in
(1) be partitioned into three sections:
,
and
, corresponding to the bound, linear and nonlinear constraints. The vector
in
(4) is similarly partitioned, and is defined as
where
is the vector of nonlinear constraints evaluated at
. The vector
is defined in an analogous fashion.
The estimated Lagrange multipliers at each major iteration are the Lagrange multipliers from the subproblem
(4) (and similarly for the predicted active set). (The numbers of bounds, general linear and nonlinear constraints in the QP active set are the quantities
Bnd,
Lin and
Nln in the output of nag_opt_nlin_lsq (e04unc); see
Section 12.3.) In nag_opt_nlin_lsq (e04unc),
(4) is solved using the same algorithm as used in function
nag_opt_lin_lsq (e04ncc). Since solving a quadratic program is an iterative procedure, the minor iterations of nag_opt_nlin_lsq (e04unc) are the iterations of
nag_opt_lin_lsq (e04ncc). (More details about solving the subproblem are given in
Section 11.2.)
Certain matrices associated with the QP subproblem are relevant in the major iterations. Let the subscripts ‘FX’ and ‘FR’ refer to the
predicted fixed and free variables, and let
denote the
by
matrix of gradients of the general linear and nonlinear constraints in the predicted active set. First, we have available the
factorization of
:
where
is a nonsingular
by
reverse-triangular matrix (i.e.,
if
, and the nonsingular
by
matrix
is the product of orthogonal transformations (see
Gill et al. (1984)). Second, we have the upper triangular Cholesky factor
of the
transformed and re-ordered Hessian matrix
where
is the Hessian
with rows and columns permuted so that the free variables are first, and
is the
by
matrix
with
the identity matrix of order
. If the columns of
are partitioned so that
the
columns of
form a basis for the null space of
. The matrix
is used to compute the projected gradient
at the current iterate. (The values
Nz,
Norm Gf and
Norm Gz printed by nag_opt_nlin_lsq (e04unc) give
and the norms of
and
; see
Section 12.3.)
A theoretical characteristic of SQP methods is that the predicted active set from the QP subproblem
(4) is identical to the correct active set in a neighbourhood of
. In nag_opt_nlin_lsq (e04unc), this feature is exploited by using the QP active set from the previous iteration as a prediction of the active set for the next QP subproblem, which leads in practice to optimality of the subproblems in only one iteration as the solution is approached. Separate treatment of bound and linear constraints in nag_opt_nlin_lsq (e04unc) also saves computation in factorizing
and
.
Once
has been computed, the major iteration proceeds by determining a step length
that produces a ‘sufficient decrease’ in an augmented Lagrangian
merit function (see
Section 11.3). Finally, the approximation to the transformed Hessian matrix
is updated using a modified BFGS quasi-Newton update (see
Section 11.4) to incorporate new curvature information obtained in the move from
to
.
On entry to nag_opt_nlin_lsq (e04unc), an iterative procedure from
nag_opt_lin_lsq (e04ncc) is executed, starting with the user-provided initial point, to find a point that is feasible with respect to the bounds and linear constraints (using the tolerance specified by
; see
Section 12.2). If no feasible point exists for the bound and linear constraints,
(1) has no solution and nag_opt_nlin_lsq (e04unc) terminates. Otherwise, the problem functions will thereafter be evaluated only at points that are feasible with respect to the bounds and linear constraints. The only exception involves variables whose bounds differ by an amount comparable to the finite difference interval (see the discussion of
in
Section 12.2). In contrast to the bounds and linear constraints, it must be emphasized that
the nonlinear constraints will not generally be satisfied until an optimal point is reached.
Facilities are provided to check whether the user-provided gradients appear to be correct (see the optional argument
in
Section 12.2). In general, the check is provided at the first point that is feasible with respect to the linear constraints and bounds. However, you may request that the check be performed at the initial point.
In summary, the method of nag_opt_nlin_lsq (e04unc) first determines a point that satisfies the bound and linear constraints. Thereafter, each iteration includes:
(a) |
the solution of a quadratic programming subproblem (see Section 11.2); |
(b) |
a linesearch with an augmented Lagrangian merit function (see Section 11.3); and |
(c) |
a quasi-Newton update of the approximate Hessian of the Lagrangian function (Section 11.4). |
11.2 Solution of the Quadratic Programming Subproblem
The search direction
is obtained by solving
(4) using the algorithm of
nag_opt_lin_lsq (e04ncc) (see
Gill et al. (1986)), which was specifically designed to be used within an SQP algorithm for nonlinear programming.
The method of
nag_opt_lin_lsq (e04ncc) is a two-phase (primal) quadratic programming method. The two phases of the method are: finding an initial feasible point by minimizing the sum of infeasibilities (the
feasibility phase), and minimizing the quadratic objective function within the feasible region (the
optimality phase). The computations in both phases are performed by the same segments of code. The two-phase nature of the algorithm is reflected by changing the function being minimized from the sum of infeasibilities to the quadratic objective function.
In general, a quadratic program must be solved by iteration. Let
denote the current estimate of the solution of 4; the new iterate
is defined by
where, as in
(3),
is a non-negative step length and
is a search direction.
At the beginning of each iteration of
nag_opt_lin_lsq (e04ncc), a
working set is defined of constraints (general and bound) that are satisfied exactly. The vector
is then constructed so that the values of constraints in the working set remain
unaltered for any move along
. For a bound constraint in the working set, this property is achieved by setting the corresponding element of
to zero, i.e., by fixing the variable at its bound. As before, the subscripts ‘FX’ and ‘FR’ denote selection of the elements associated with the fixed and free variables.
Let
denote the sub-matrix of rows of
corresponding to general constraints in the working set. The general constraints in the working set will remain unaltered if
which is equivalent to defining
as
for some vector
, where
is the matrix associated with the
factorization
(5) of
.
The definition of
in
(10) depends on whether the current
is feasible. If not,
is zero except for an element
in the
th position, where
and
are chosen so that the sum of infeasibilities is decreasing along
. (For further details, see
Gill et al. (1986).) In the feasible case,
satisfies the equations
where
is the Cholesky factor of
and
is the gradient of the quadratic objective function
. (The vector
is the projected gradient of the QP.) With
(11),
is the minimizer of the quadratic objective function subject to treating the constraints in the working set as equalities.
If the QP projected gradient is zero, the current point is a constrained stationary point in the subspace defined by the working set. During the feasibility phase, the projected gradient will usually be zero only at a vertex (although it may vanish at non-vertices in the presence of constraint dependencies). During the optimality phase, a zero projected gradient implies that minimizes the quadratic objective function when the constraints in the working set are treated as equalities. In either case, Lagrange multipliers are computed. Given a positive constant of the order of the machine precision, the Lagrange multiplier corresponding to an inequality constraint in the working set at its upper bound is said to be optimal if when the th constraint is at its upper bound, or if when the associated constraint is at its lower bound. If any multiplier is non-optimal, the current objective function (either the true objective or the sum of infeasibilities) can be reduced by deleting the corresponding constraint from the working set.
If optimal multipliers occur during the feasibility phase and the sum of infeasibilities is nonzero, no feasible point exists. The QP algorithm will then continue iterating to determine the minimum sum of infeasibilities. At this point, the Lagrange multiplier will satisfy for an inequality constraint at its upper bound, and for an inequality at its lower bound. The Lagrange multiplier for an equality constraint will satisfy .
The choice of step length
in the QP iteration
(8) is based on remaining feasible with respect to the satisfied constraints. During the optimality phase, if
is feasible,
will be taken as unity. (In this case, the projected gradient at
will be zero.) Otherwise,
is set to
, the step to the ‘nearest’ constraint, which is added to the working set at the next iteration.
Each change in the working set leads to a simple change to : if the status of a general constraint changes, a row of is altered; if a bound constraint enters or leaves the working set, a column of changes. Explicit representations are recurred of the matrices , and , and of the vectors and .
11.3 The Merit Function
After computing the search direction as described in
Section 11.2, each major iteration proceeds by determining a step length
in
(3) that produces a ‘sufficient decrease’ in the augmented Lagrangian merit function
where
,
and
vary during the
linesearch. The summation terms in
(12) involve only the
nonlinear constraints. The vector
is an estimate of the Lagrange multipliers for the nonlinear constraints of
(1). The non-negative
slack variables allow nonlinear inequality constraints to be treated without introducing discontinuities. The solution of the QP subproblem
(4) provides a vector triple that serves as a direction of search for the three sets of variables. The non-negative vector
of
penalty arguments is initialized to zero at the beginning of the first major iteration. Thereafter, selected elements are increased whenever necessary to ensure descent for the merit function. Thus, the sequence of norms of
(the printed quantity
Penalty; see
Section 12.3) is generally nondecreasing, although each
may be reduced a limited number of times.
The merit function
(12) and its global convergence properties are described in
Gill et al. (1986a).
11.4 The Quasi–Newton Update
The matrix
in
(4) is a
positive definite quasi-Newton approximation to the Hessian of the Lagrangian function. (For a review of quasi-Newton methods, see
Dennis and Schnabel (1983).) At the end of each major iteration, a new Hessian approximation
is defined as a rank-two modification of
. In nag_opt_nlin_lsq (e04unc), the BFGS quasi-Newton update is used:
where
(the change in
).
In nag_opt_nlin_lsq (e04unc),
is required to be positive definite. If
is positive definite,
defined by
(13) will be positive definite if and only if
is positive (see, e.g.,
Dennis and Moré (1977)). Ideally,
in
(13) would be taken as
, the change in gradient of the Lagrangian function
where
denotes the QP multipliers associated with the nonlinear constraints of the original problem. If
is not sufficiently positive, an attempt is made to perform the update with a vector
of the form
where
. If no such vector can be found, the update is performed with a scaled
; in this case,
M is printed to indicate that the update was modified.
Rather than modifying
itself, the Cholesky factor of the
transformed Hessian (6) is updated, where
is the matrix from
(5) associated with the active set of the QP subproblem. The update
(12) is equivalent to the following update to
:
where
, and
. This update may be expressed as a
rank-one update to
(see
Dennis and Schnabel (1981)).
12 Optional Arguments
A number of optional input and output arguments to nag_opt_nlin_lsq (e04unc) are available through the structure argument
options, type Nag_E04_Opt. An argument may be selected by assigning an appropriate value to the relevant structure member; those arguments not selected will be assigned default values. If no use is to be made of any of the optional arguments you should use the NAG defined null pointer,
E04_DEFAULT, in place of
options when calling nag_opt_nlin_lsq (e04unc); the default settings will then be used for all arguments.
Before assigning values to
options directly the structure
must be initialized by a call to the function
nag_opt_init (e04xxc). Values may then be assigned to the structure members in the normal C manner.
Option settings may also be read from a text file using the function
nag_opt_read (e04xyc) in which case initialization of the
options structure will be performed automatically if not already done. Any subsequent direct assignment to the
options structure must
not be preceded by initialization.
If assignment of functions and memory to pointers in the
options structure is required, then this must be done directly in the calling program; they cannot be assigned using
nag_opt_read (e04xyc).
12.1 Optional Argument Checklist and Default Values
For easy reference, the following list shows the members of
options which are valid for nag_opt_nlin_lsq (e04unc) together with their default values where relevant. The number
is a generic notation for
machine precision (see
nag_machine_precision (X02AJC)).
Nag_Start start |
|
Boolean list |
Nag_TRUE |
Nag_PrintType print_level |
|
Nag_PrintType minor_print_level |
|
char outfile[80] |
stdout |
void (*print_fun)() |
NULL |
Boolean obj_deriv |
Nag_TRUE |
Boolean con_deriv |
Nag_TRUE |
Nag_GradChk verify_grad |
|
Nag_DPrintType print_deriv |
|
Integer obj_check_start |
1 |
Integer obj_check_stop |
n |
Integer con_check_start |
1 |
Integer con_check_stop |
n |
double f_diff_int |
Computed automatically |
double c_diff_int |
Computed automatically |
Integer max_iter |
|
Integer minor_max_iter |
|
double f_prec |
|
double optim_tol |
|
double lin_feas_tol |
|
double nonlin_feas_tol |
or |
double linesearch_tol |
0.9 |
double step_limit |
|
double crash_tol |
0.01 |
double inf_bound |
|
double inf_step |
|
double *conf |
size ncnlin |
double *conjac |
size |
Integer *state |
size |
double *lambda |
size |
double *h |
size |
Boolean hessian |
Nag_FALSE |
Boolean h_unit_init |
Nag_FALSE |
Integer h_reset_freq |
2 |
Integer iter |
Integer nf |
12.2 Description of the Optional Arguments
start – Nag_Start | | Default |
On entry: specifies how the initial working set is chosen in both the procedure for finding a feasible point for the linear constraints and bounds, and in the first QP subproblem thereafter. With
, nag_opt_nlin_lsq (e04unc) chooses the initial working set based on the values of the variables and constraints at the initial point. Broadly speaking, the initial working set will include equality constraints and bounds or inequality constraints that violate or ‘nearly’ satisfy their bounds (to within the value of the optional argument
; see below).
With
, you must provide a valid definition of every array element of the optional arguments
,
and
(see below for their definitions). The
values associated with bounds and linear constraints determine the initial working set of the procedure to find a feasible point with respect to the bounds and linear constraints. The
values associated with nonlinear constraints determine the initial working set of the first QP subproblem after such a feasible point has been found. nag_opt_nlin_lsq (e04unc) will override your specification of
if necessary, so that a poor choice of the working set will not cause a fatal error. For instance, any elements of
which are set to
or 4 will be reset to zero, as will any elements which are set to 3 when the corresponding elements of
bl and
bu are not equal. A warm start will be advantageous if a good estimate of the initial working set is available – for example, when nag_opt_nlin_lsq (e04unc) is called repeatedly to solve related problems.
Constraint:
or .
list – Nag_Boolean | | Default |
On entry: if the argument settings in the call to nag_opt_nlin_lsq (e04unc) will be printed.
print_level – Nag_PrintType | | Default |
On entry: the level of results printout produced by nag_opt_nlin_lsq (e04unc) at each major iteration. The following values are available:
| No output. |
| The final solution. |
| One line of output for each iteration. |
| A longer line of output for each iteration with more information (line exceeds 80 characters). |
| The final solution and one line of output for each iteration. |
| The final solution and one long line of output for each iteration (line exceeds 80 characters). |
| As with the objective function, the values of the variables, the Euclidean norm of the nonlinear constraint violations, the nonlinear constraint values, , and the linear constraint values also printed at each iteration. |
| As with the diagonal elements of the upper triangular matrix associated with the factorization (see (5)) of the QP working set, and the diagonal elements of , the triangular factor of the transformed and re-ordered Hessian (see (6)). |
Details of each level of results printout are described in
Section 12.3.
Constraint:
, , , , , , or .
minor_print_level – Nag_PrintType | | Default |
On entry: the level of results printout produced by the minor iterations of nag_opt_nlin_lsq (e04unc) (i.e., the iterations of the QP subproblem). The following values are available:
| No output. |
| The final solution. |
| One line of output for each iteration. |
| A longer line of output for each iteration with more information (line exceeds 80 characters). |
| The final solution and one line of output for each iteration. |
| The final solution and one long line of output for each iteration (line exceeds 80 characters). |
| As with the Lagrange multipliers, the variables , the constraint values and the constraint status also printed at each iteration. |
| As with the diagonal elements of the upper triangular matrix associated with the factorization (see (4) in nag_opt_lin_lsq (e04ncc)) of the working set, and the diagonal elements of the upper triangular matrix printed at each iteration. |
Details of each level of results printout are described in
Section 12.3 in nag_opt_lin_lsq (e04ncc). (
in the present function is equivalent to
in
nag_opt_lin_lsq (e04ncc).)
Constraint:
, , , , , , or .
outfile – const char[80] | | Default |
On entry: the name of the file to which results should be printed. If then the stdout stream is used.
print_fun – pointer to function | | Default NULL |
On entry: printing function defined by you; the prototype of
is
void (*print_fun)(const Nag_Search_State *st, Nag_Comm *comm);
See
Section 12.3.1 below for further details.
obj_deriv – Nag_Boolean | | Default |
On entry: this argument indicates whether all elements of the objective Jacobian are provided in function
objfun. If none or only some of the elements are being supplied by
objfun then
should be set to Nag_FALSE.
Whenever possible all elements should be supplied, since nag_opt_nlin_lsq (e04unc) is more reliable and will usually be more efficient when all derivatives are exact.
If
, nag_opt_nlin_lsq (e04unc) will approximate unspecified elements of the objective Jacobian, using finite differences. The computation of finite difference approximations usually increases the total run-time, since a call to
objfun is required for each unspecified element. Furthermore, less accuracy can be attained in the solution (see
Gill et al. (1981), for a discussion of limiting accuracy).
At times, central differences are used rather than forward differences, in which case twice as many calls to
objfun are needed. (The switch to central differences is not under your control.)
con_deriv – Nag_Boolean | | Default |
On entry: this argument indicates whether all elements of the constraint Jacobian are provided in function
confun. If none or only some of the derivatives are being supplied by
confun then
should be set to Nag_FALSE.
Whenever possible all elements should be supplied, since nag_opt_nlin_lsq (e04unc) is more reliable and will usually be more efficient when all derivatives are exact.
If
, nag_opt_nlin_lsq (e04unc) will approximate unspecified elements of the constraint Jacobian. One call to
confun is needed for each variable for which partial derivatives are not available. For example, if the constraint Jacobian has the form
where
indicates a provided element and ‘?’ indicates an unspecified element, nag_opt_nlin_lsq (e04unc) will call
confun twice: once to estimate the missing element in column 2, and again to estimate the two missing elements in column 3. (Since columns 1 and 4 are known, they require no calls to
confun.)
At times, central differences are used rather than forward differences, in which case twice as many calls to
confun are needed. (The switch to central differences is not under your control.)
verify_grad – Nag_GradChk | | Default |
On entry: specifies the level of derivative checking to be performed by nag_opt_nlin_lsq (e04unc) on the gradient elements computed by the user-supplied functions
objfun and
confun.
The following values are available:
| No derivative checking is performed. |
| Perform a simple check of both the objective and constraint gradients. |
| Perform a component check of the objective gradient elements. |
| Perform a component check of the constraint gradient elements. |
| Perform a component check of both the objective and constraint gradient elements. |
| Perform a simple check of both the objective and constraint gradients at the initial value of specified in x. |
| Perform a component check of the objective gradient elements at the initial value of specified in x. |
| Perform a component check of the constraint gradient elements at the initial value of specified in x. |
| Perform a component check of both the objective and constraint gradient elements at the initial value of specified in x. |
If
or
then a simple ‘cheap’ test is performed, which requires only one call to
objfun and one call to
confun. If
,
or
then a more reliable (but more expensive) test will be made on individual gradient components. This component check will be made in the range specified by the optional argument
and
for the objective gradient, with default values
and
n, respectively. For the constraint gradient the range is specified by
and
, with default values
and
n.
The procedure for the derivative check is based on finding an interval that produces an acceptable estimate of the second derivative, and then using that estimate to compute an interval that should produce a reasonable forward-difference approximation. The gradient element is then compared with the difference approximation. (The method of finite difference interval estimation is based on
Gill et al. (1983).) The result of the test is printed out by nag_opt_nlin_lsq (e04unc) if the optional argument
.
Constraint:
, , , , , , , or .
print_deriv – Nag_DPrintType | | Default |
On entry: controls whether the results of any derivative checking are printed out (see optional argument
).
If a component derivative check has been carried out, then full details will be printed if . For a printout summarising the results of a component derivative check set . If only a simple derivative check is requested then and will give the same level of output. To prevent any printout from a derivative check set .
Constraint:
, or .
obj_check_start – Integer | | Default |
obj_check_stop – Integer | | Default |
These options take effect only when , , or .
On entry: these arguments may be used to control the verification of Jacobian elements computed by the function
objfun. For example, if the first 30 columns of the objective Jacobian appeared to be correct in an earlier run, so that only column 31 remains questionable, it is reasonable to specify
. If the first 30 variables appear linearly in the subfunctions, so that the corresponding Jacobian elements are constant, the above choice would also be appropriate.
Constraint:
.
con_check_start – Integer | | Default |
con_check_stop – Integer | | Default |
These options take effect only when , , or .
On entry: these arguments may be used to control the verification of the Jacobian elements computed by the function
confun. For example, if the first 30 columns of the constraint Jacobian appeared to be correct in an earlier run, so that only column 31 remains questionable, it is reasonable to specify
.
Constraint:
.
f_diff_int – double | | Default computed automatically |
On entry: defines an interval used to estimate derivatives by finite differences in the following circumstances:
(a) |
For verifying the objective and/or constraint gradients (see the description of the optional argument ). |
(b) |
For estimating unspecified elements of the objective and/or constraint Jacobian matrix. |
In general, using the notation
, a derivative with respect to the
th variable is approximated using the interval
, where
, with
the first point feasible with respect to the bounds and linear constraints. If the functions are well scaled, the resulting derivative approximation should be accurate to O
. See Chapter 8 of
Gill et al. (1981) for a discussion of the accuracy in finite difference approximations.
If a difference interval is not specified by you, a finite difference interval will be computed automatically for each variable by a procedure that requires up to six calls of
confun and
objfun for each element. This option is recommended if the function is badly scaled or you wish to have nag_opt_nlin_lsq (e04unc) determine constant elements in the objective and constraint gradients (see the descriptions of
confun and
objfun in
Section 5).
Constraint:
.
c_diff_int – double | | Default computed automatically |
On entry: if the algorithm switches to central differences because the forward-difference approximation is not sufficiently accurate the value of
is used as the difference interval for every element of
. The switch to central differences is indicated by
C at the end of each line of intermediate printout produced by the major iterations (see
Section 5.1). The use of finite differences is discussed under the option
.
Constraint:
.
max_iter – Integer | | Default |
On entry: the maximum number of major iterations allowed before termination.
Constraint:
.
minor_max_iter – Integer | | Default |
On entry: the maximum number of iterations for finding a feasible point with respect to the bounds and linear constraints (if any). The value also specifies the maximum number of minor iterations for the optimality phase of each QP subproblem.
Constraint:
.
f_prec – double | | Default |
On entry: this argument defines
, which is intended to be a measure of the accuracy with which the problem functions
and
can be computed.
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 1000 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 nag_opt_nlin_lsq (e04unc) will not attempt to distinguish between function values that differ by less than the error inherent in the calculation.
Constraint:
.
optim_tol – double | | Default |
On entry: 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 nag_opt_nlin_lsq (e04unc) terminates successfully, the final value of
should have approximately six correct figures.
nag_opt_nlin_lsq (e04unc) will terminate successfully if the iterative sequence of
-values is judged to have converged and the final point satisfies the first-order Kuhn–Tucker conditions (see
Section 11.1). The sequence of iterates is considered to have converged at
if
where
is the search direction,
the step length, and
is the value of
. An iterate is considered to satisfy the first-order conditions for a minimum if
and
where
is the projected gradient (see
Section 11.1),
is the gradient of
with respect to the free variables,
is the violation of the
th active nonlinear constraint, and
is the value of the optional argument
.
Constraint:
.
lin_feas_tol – double | | Default |
On entry: defines the maximum acceptable
absolute violations in the linear constraints at a ‘feasible’ point; i.e., a linear constraint is considered satisfied if its violation does not exceed
.
On entry to nag_opt_nlin_lsq (e04unc), an iterative procedure is executed in order to find a point that satisfies the linear constraints and bounds on the variables to within the tolerance specified by . All subsequent iterates will satisfy the constraints to within the same tolerance (unless is comparable to the finite difference interval).
This tolerance should reflect the precision of the linear constraints. For example, if the variables and the coefficients in the linear constraints are of order unity, and the latter are correct to about 6 decimal digits, it would be appropriate to specify as .
Constraint:
.
nonlin_feas_tol – double | | Default or |
The default is if the optional argument , and otherwise.
On entry: defines the maximum acceptable
absolute violations in the nonlinear constraints at a ‘feasible’ point; i.e., a nonlinear constraint is considered satisfied if its violation does not exceed
.
This tolerance defines the largest constraint violation that is acceptable at an optimal point. Since nonlinear constraints are generally not satisfied until the final iterate, the value of acts as a partial termination criterion for the iterative sequence generated by nag_opt_nlin_lsq (e04unc) (see also the discussion of the optional argument ).
This tolerance should reflect the precision of the nonlinear constraint functions calculated by
confun.
Constraint:
.
linesearch_tol – double | | Default |
On entry: controls the accuracy with which the step
taken during each iteration approximates a minimum of the merit function along the search direction (the smaller the value of
, the more accurate the line search). The default value requests an inaccurate search, and is appropriate for most problems, particularly those with any nonlinear constraints.
If there are no nonlinear constraints, a more accurate search may be appropriate when it is desirable to reduce the number of major iterations – for example, if the objective function is cheap to evaluate, or if a substantial number of derivatives are unspecified.
Constraint:
.
step_limit – double | | Default |
On entry: specifies the maximum change in the variables at the first step of the line search. In some cases, such as
or
, even a moderate change in the elements of
can lead to floating-point overflow. The argument
is therefore used to encourage evaluation of the problem functions at meaningful points. Given any major iterate
, the first point
at which
and
are evaluated during the line search is restricted so that
where
is the value of
.
The line search may go on and evaluate
and
at points further from
if this will result in a lower value of the merit function. In this case, the character
L is printed at the end of each line of output produced by the major iterations (see
Section 5.1). If
L is printed for most of the iterations,
should be set to a larger value.
Wherever possible, upper and lower bounds on should be used to prevent evaluation of nonlinear functions at wild values. The default value of should not affect progress on well-behaved functions, but values such as 0.1 or 0.01 may be helpful when rapidly varying functions are present. If a small value of is selected, a good starting point may be required. An important application is to the class of nonlinear least squares problems.
Constraint:
.
crash_tol – double | | Default |
On entry: is used during a ‘cold start’ when nag_opt_nlin_lsq (e04unc) selects an initial working set (). The initial working set will include (if possible) bounds or general inequality constraints that lie within of their bounds. In particular, a constraint of the form will be included in the initial working set if .
Constraint:
.
inf_bound – double | | Default |
On entry: defines the ‘infinite’ bound in the definition of the problem constraints. Any upper bound greater than or equal to will be regarded as (and similarly any lower bound less than or equal to will be regarded as ).
Constraint:
.
inf_step – double | | Default |
On entry: specifies the magnitude of the change in variables that will be considered a step to an unbounded solution. If the change in during an iteration would exceed the value of , the objective function is considered to be unbounded below in the feasible region.
Constraint:
.
conf – double * | | Default memory |
On entry:
ncnlin values of memory will be automatically allocated by nag_opt_nlin_lsq (e04unc) and this is the recommended method of use of
. However you may supply memory from the calling program.
On exit: if
,
contains the value of the
th nonlinear constraint function
at the final iterate.
If then will not be referenced.
conjac – double * | | Default memory |
On entry: values of memory will be automatically allocated by nag_opt_nlin_lsq (e04unc) and this is the recommended method of use of . However you may supply memory from the calling program.
On exit: if
,
conjac contains the Jacobian matrix of the nonlinear constraint functions at the final iterate, i.e.,
contains the partial derivative of the
th constraint function with respect to the
th variable, for
and
. (See the discussion of the argument
conjac under
confun.)
If
then
conjac will not be referenced.
state – Integer * | | Default memory |
On entry:
need not be set if the default option of
is used as
values of memory will be automatically allocated by nag_opt_nlin_lsq (e04unc).
If the option
has been chosen,
must point to a minimum of
elements of memory. This memory will already be available if the
options structure has been used in a previous call to nag_opt_nlin_lsq (e04unc) from the calling program, with
and the same values of
n,
nclin and
ncnlin. If a previous call has not been made, sufficient memory must be allocated by you.
When a ‘warm start’ is chosen
should specify the status of the bounds and linear constraints at the start of the feasibility phase. More precisely, the first
n elements of
refer to the upper and lower bounds on the variables, the next
nclin elements refer to the general linear constraints and the following
ncnlin elements refer to the nonlinear constraints. Possible values for
are as follows:
|
Meaning |
0 |
The corresponding constraint is not in the initial QP working set. |
1 |
This inequality constraint should be in the initial working set at its lower bound. |
2 |
This inequality constraint should be in the initial working set at its upper bound. |
3 |
This equality constraint should be in the initial working set. This value must only be specified if . |
The values
,
and 4 are also acceptable but will be reset to zero by the function, as will any elements which are set to 3 when the corresponding elements of
bl and
bu are not equal. If nag_opt_nlin_lsq (e04unc) has been called previously with the same values of
n,
nclin and
ncnlin, then
already contains satisfactory information. (See also the description of the optional argument
.) The function also adjusts (if necessary) the values supplied in
x to be consistent with the values supplied in
.
Constraint:
, for .
On exit: the status of the constraints in the QP working set at the point returned in
x. The significance of each possible value of
is as follows:
|
Meaning |
|
The constraint violates its lower bound by more than the appropriate feasibility tolerance (see the options and ). This value can occur only when no feasible point can be found for a QP subproblem. |
|
The constraint violates its upper bound by more than the appropriate feasibility tolerance (see the options and ). This value can occur only when no feasible point can be found for a QP subproblem. |
|
The constraint is satisfied to within the feasibility tolerance, but is not in the QP working set. |
|
This inequality constraint is included in the QP working set at its lower bound. |
|
This inequality constraint is included in the QP working set at its upper bound. |
|
This constraint is included in the working set as an equality. This value of can occur only when . |
lambda – double * | | Default memory |
On entry:
need not be set if the default option
is used as
values of memory will be automatically allocated by nag_opt_nlin_lsq (e04unc).
If the option
has been chosen,
must point to a minimum of
elements of memory. This memory will already be available if the
options structure has been used in a previous call to nag_opt_nlin_lsq (e04unc) from the calling program, with
and the same values of
n,
nclin and
ncnlin. If a previous call has not been made, sufficient memory must be allocated by you.
When a ‘warm start’ is chosen must contain a multiplier estimate for each nonlinear constraint with a sign that matches the status of the constraint specified by , for . The remaining elements need not be set.
Note that if the th constraint is defined as ‘inactive’ by the initial value of the array (i.e., ), should be zero; if the th constraint is an inequality active at its lower bound (i.e., ), should be non-negative; if the th constraint is an inequality active at its upper bound (i.e., ), should be non-positive. If necessary, the function will modify to match these rules.
On exit: the values of the Lagrange multipliers from the last QP subproblem. should be non-negative if and non-positive if .
h – double * | | Default memory |
On entry:
need not be set if the default option of
is used as
values of memory will be automatically allocated by nag_opt_nlin_lsq (e04unc).
If the option
has been chosen,
must point to a minimum of
elements of memory. This memory will already be available if the calling program has used the
options structure in a previous call to nag_opt_nlin_lsq (e04unc) with
and the same value of
n. If a previous call has not been made sufficient memory must be allocated to by you.
When is chosen the memory pointed to by must contain the upper triangular Cholesky factor of the initial approximation of the Hessian of the Lagrangian function, with the variables in the natural order. Elements not in the upper triangular part of are assumed to be zero and need not be assigned. If a previous call has been made, with , then will already have been set correctly.
On exit: if
,
contains the upper triangular Cholesky factor
of
, an estimate of the transformed and re-ordered Hessian of the Lagrangian at
(see
(6)).
If , contains the upper triangular Cholesky factor of , the approximate (untransformed) Hessian of the Lagrangian, with the variables in the natural order.
hessian – Nag_Boolean | | Default |
On entry: controls the contents of the optional argument on return from nag_opt_nlin_lsq (e04unc). nag_opt_nlin_lsq (e04unc) works exclusively with the transformed and
re-ordered Hessian , and hence extra computation is required to form the Hessian itself. If , contains the Cholesky factor of the transformed and re-ordered Hessian. If , the Cholesky factor of the approximate Hessian itself is formed and stored in . This information is required by nag_opt_nlin_lsq (e04unc) if the next call to nag_opt_nlin_lsq (e04unc) will be made with optional argument .
h_unit_init – Nag_Boolean | | Default |
On entry: if the initial value of the upper triangular matrix is set to , where denotes the objective Jacobian matrix . is often a good approximation to the objective Hessian matrix . If then the initial value of is the unit matrix.
h_reset_freq – Integer | | Default |
On entry: this argument allows you to reset the approximate Hessian matrix to
every
iterations, where
is the objective Jacobian matrix
.
At any point where there are no nonlinear constraints active and the values of are small in magnitude compared to the norm of , will be a good approximation to the objective Hessian matrix . Under these circumstances, frequent resetting can significantly improve the convergence rate of nag_opt_nlin_lsq (e04unc).
Resetting is suppressed at any iteration during which there are nonlinear constraints active.
Constraint:
.
On exit: the number of major iterations which have been performed in nag_opt_nlin_lsq (e04unc).
On exit: the number of times the objective function has been evaluated (i.e., number of calls of
objfun). The total excludes any calls made to
objfun for purposes of derivative checking.
12.3 Description of Printed Output
The level of printed output can be controlled with the structure members
,
,
and
(see
Section 12.2). If
then the argument values to nag_opt_nlin_lsq (e04unc) are listed, followed by the result of any derivative check if
or
. The printout of results is governed by the values of
and
. The default of
and
provides a single line of output at each iteration and the final result. This section describes all of the possible levels of results printout available from nag_opt_nlin_lsq (e04unc).
If a simple derivative check, , is requested then a statement indicating success or failure is given. The largest error found in the objective and the constraint Jacobian are also output.
When a component derivative check (see
in
Section 12.2) is selected the element with the largest relative error is identified for the objective and the constraint Jacobian.
If
then the following results are printed for each component:
x[i] |
the element of . |
dx[i] |
the optimal finite difference interval. |
Jacobian value |
the Jacobian element. |
Difference approxn. |
the finite difference approximation. |
Itns |
the number of trials performed to find a suitable difference interval. |
The indicator,
OK or
BAD?, states whether the Jacobian element and finite difference approximation are in agreement. If the derivatives are believed to be in error nag_opt_nlin_lsq (e04unc) will exit with
fail set to
NE_DERIV_ERRORS.
When
or
the following line of output is produced at every major iteration. In all cases, the values of the quantities printed are those in effect
on completion of the given iteration.
Maj |
is the major iteration count. |
Mnr |
is the number of minor iterations required by the feasibility and optimality phases of the QP subproblem. Generally, Mnr will be 1 in the later iterations, since theoretical analysis predicts that the correct active set will be identified near the solution (see Section 11). Note that Mnr may be greater than the optional argument (default value ; see Section 12.2) if some iterations are required for the feasibility phase. |
Step |
is the step taken along the computed search direction. On reasonably well-behaved problems, the unit step will be taken as the solution is approached. |
Merit function |
is the value of the augmented Lagrangian merit function at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty arguments (see Section 11.3). As the solution is approached, Merit function will converge to the value of the objective function at the solution.
If the QP subproblem does not have a feasible point (signified by I at the end of the current output line), the merit function is a large multiple of the constraint violations, weighted by the penalty arguments. During a sequence of major iterations with infeasible subproblems, the sequence of Merit Function values will decrease monotonically until either a feasible subproblem is obtained or nag_opt_nlin_lsq (e04unc) terminates with the error indicator NW_NONLIN_NOT_FEASIBLE (no feasible point could be found for the nonlinear constraints).
If no nonlinear constraints are present (i.e., ), this entry contains Objective, the value of the objective function . The objective function will decrease monotonically to its optimal value when there are no nonlinear constraints. |
Violtn |
is the Euclidean norm of the residuals of constraints that are violated or in the predicted active set (not printed if ncnlin is zero). Violtn will be approximately zero in the neighbourhood of a solution. |
Norm Gz |
is , the Euclidean norm of the projected gradient (see Section 11.1). Norm Gz will be approximately zero in the neighbourhood of a solution. |
Cond Hz |
is a lower bound on the condition number of the projected Hessian approximation ; see (6) and (11), respectively). The larger this number, the more difficult the problem. |
The line of output may be terminated by one of the following characters:
M |
is printed if the quasi-Newton update was modified to ensure that the Hessian approximation is positive definite (see Section 11.4). |
I |
is printed if the QP subproblem has no feasible point. |
C |
is printed if central differences were used to compute the unspecified objective and constraint gradients. If the value of Step is zero, the switch to central differences was made because no lower point could be found in the line search. (In this case, the QP subproblem is re-solved with the central difference gradient and Jacobian.) If the value of Step is nonzero, central differences were computed because Norm Gz and Violtn imply that is close to a Kuhn–Tucker point (see Section 11.1). |
L |
is printed if the line search has produced a relative change in greater than the value defined by the optional argument (default value ; see Section 12.2). If this output occurs frequently during later iterations of the run, should be set to a larger value. |
R |
is printed if the approximate Hessian has been refactorized. If the diagonal condition estimator of indicates that the approximate Hessian is badly conditioned, the approximate Hessian is refactorized using column interchanges. If necessary, is modified so that its diagonal condition estimator is bounded. |
If
,
,
or
the line of printout at every iteration is extended to give the following additional information. (Note this longer line extends over more than 80 characters.)
Nfun |
is the cumulative number of evaluations of the objective function needed for the line search. Evaluations needed for the estimation of the gradients by finite differences are not included. Nfun is printed as a guide to the amount of work required for the linesearch. |
Nz |
is the number of columns of (see Section 11.1). The value of Nz is the number of variables minus the number of constraints in the predicted active set; i.e., . |
Bnd |
is the number of simple bound constraints in the predicted active set. |
Lin |
is the number of general linear constraints in the predicted active set. |
Nln |
is the number of nonlinear constraints in the predicted active set (not printed if ncnlin is zero). |
Penalty |
is the Euclidean norm of the vector of penalty arguments used in the augmented Lagrangian merit function (not printed if ncnlin is zero). |
Norm Gf |
is the Euclidean norm of , the gradient of the objective function with respect to the free variables. |
Cond H |
is a lower bound on the condition number of the Hessian approximation . |
Cond T |
is a lower bound on the condition number of the matrix of predicted active constraints. |
Conv |
is a three-letter indication of the status of the three convergence tests (16)–(18) defined in the description of the optional argument in Section 12.2. Each letter is T if the test is satisfied, and F otherwise. The three tests indicate whether:
(a) |
the sequence of iterates has converged; |
(b) |
the projected gradient (Norm Gz) is sufficiently small; and |
(c) |
the norm of the residuals of constraints in the predicted active set (Violtn) is small enough. |
|
|
If any of these indicators is F when nag_opt_nlin_lsq (e04unc) terminates with the error indicator NE_NOERROR, you should check the solution carefully. |
When
or
more detailed results are given at each iteration. If
these additional values are: the value of
currently held in
x; the current value of the objective function; the Euclidean norm of nonlinear constraint violations; the values of the nonlinear constraints (the vector
); and the values of the linear constraints, (the vector
).
If
then the diagonal elements of the matrix
associated with the
factorization (see
(5)) of the QP working set and the diagonal elements of
, the triangular factor of the transformed and re-ordered Hessian (see
(6)) are also output at each iteration.
When
,
,
,
or
the final printout from nag_opt_nlin_lsq (e04unc) includes a listing of the status of every variable and constraint. The following describes the printout for each variable.
Varbl |
gives the name (V) and index , for , of the variable. |
State |
gives the state of the variable (FR if neither bound is in the active set, EQ if a fixed variable, LL if on its lower bound, UL if on its upper bound). If Value lies outside the upper or lower bounds by more than the feasibility tolerances specified by the optional arguments and (see Section 12.2), State will be ++ or -- respectively.
A key is sometimes printed before State to give some additional information about the state of a variable.
A |
Alternative optimum possible. The variable is active at one of its bounds, but its Lagrange Multiplier is essentially zero. This means that if the variable were allowed to start moving away from its bound, there would be no change to the objective function. The values of the other free variables might change, giving a genuine alternative solution. However, if there are any degenerate variables (labelled D), the actual change might prove to be zero, since one of them could encounter a bound immediately. In either case, the values of the Lagrange multipliers might also change. |
D |
Degenerate. The variable is free, but it is equal to (or very close to) one of its bounds. |
I |
Infeasible. The variable is currently violating one of its bounds by more than . |
|
Value |
is the value of the variable at the final iteration. |
Lower bound |
is the lower bound specified for the variable . (None indicates that , where is the optional argument.) |
Upper bound |
is the upper bound specified for the variable . (None indicates that , where is the optional argument.) |
Lagr Mult |
is the value of the Lagrange multiplier for the associated bound constraint. This will be zero if State is FR unless and , in which case the entry will be blank. If is optimal, the multiplier should be non-negative if State is LL, and non-positive if State is UL. |
Residual |
is the difference between the variable Value and the nearer of its (finite) bounds and . A blank entry indicates that the associated variable is not bounded (i.e., and ). |
The meaning of the printout for linear and nonlinear constraints is the same as that given above for variables, with ‘variable’ replaced by ‘constraint’,
and
are replaced by
and
respectively, and with the following changes in the heading:
L Con |
gives the name (L) and index , for , of the linear constraint. |
N Con |
gives the name (N) and index , for , of the nonlinear constraint. |
The I key in the State column is printed for general linear constraints which currently violate one of their bounds by more than and for nonlinear constraints which violate one of their bounds by more than .
Note that movement off a constraint (as opposed to a variable moving away from its bound) can be interpreted as allowing the entry in the Residual column to become positive.
Numerical values are output with a fixed number of digits; they are not guaranteed to be accurate to this precision.
For the output governed by
, you are referred to the documentation for
nag_opt_lin_lsq (e04ncc). The option
in the current document is equivalent to
in the documentation for
nag_opt_lin_lsq (e04ncc).
If then printout will be suppressed; you can print the final solution when nag_opt_nlin_lsq (e04unc) returns to the calling program.
12.3.1 Output of results via a user-defined printing function
You may also specify your own print function for output of iteration results and the final solution by use of the
function pointer, which has prototype
void (*print_fun)(const Nag_Search_State *st, Nag_Comm *comm);
This section may be skipped if you wish to use the default printing facilities.
When a user-defined function is assigned to
this will be called in preference to the internal print function of nag_opt_nlin_lsq (e04unc). Calls to the user-defined function are again controlled by means of the
,
and
members. Information is provided through
st and
comm, the two structure arguments to
.
If then results from the last major iteration of nag_opt_nlin_lsq (e04unc) are provided through st. Note that will be called with only if , , , or . The following members of st are set:
- n – Integer
-
The number of variables.
- nclin – Integer
-
The number of linear constraints.
- ncnlin – Integer
-
The number of nonlinear constraints.
- nactiv – Integer
-
The total number of active elements in the current set.
- iter – Integer
-
The major iteration count.
- minor_iter – Integer
-
The minor iteration count for the feasibility and the optimality phases of the QP subproblem.
- step – double
-
The step taken along the computed search direction.
- nfun – Integer
-
The cumulative number of objective function evaluations needed for the line search.
- merit – double
-
The value of the augmented Lagrangian merit function at the current iterate.
- objf – double
-
The current value of the objective function.
- norm_nlnviol – double
-
The Euclidean norm of nonlinear constraint violations (only available if ).
- violtn – double
-
The Euclidean norm of the residuals of constraints that are violated or in the predicted active set (only available if ).
- norm_gz – double
-
, the Euclidean norm of the projected gradient.
- nz – Integer
-
The number of columns of
(see
Section 11.1).
- bnd – Integer
-
The number of simple bound constraints in the predicted active set.
- lin – Integer
-
The number of general linear constraints in the predicted active set.
- nln – Integer
-
The number of nonlinear constraints in the predicted active set (only available if ).
- penalty – double
-
The Euclidean norm of the vector of penalty arguments used in the augmented Lagrangian merit function (only available if ).
- norm_gf – double
-
The Euclidean norm of , the gradient of the objective function with respect to the free variables.
- cond_h – double
-
A lower bound on the condition number of the Hessian approximation .
- cond_hz – double
-
A lower bound on the condition number of the projected Hessian approximation .
- cond_t – double
-
A lower bound on the condition number of the matrix of predicted active constraints.
- iter_conv – Nag_Boolean
-
Nag_TRUE if the sequence of iterates has converged, i.e., convergence condition
(16) (see the description of
in
Section 12.2) is satisfied.
- norm_gz_small – Nag_Boolean
-
Nag_TRUE if the projected gradient is sufficiently small, i.e., convergence condition
(17) (see the description of
in
Section 12.2) is satisfied.
- violtn_small – Nag_Boolean
-
Nag_TRUE if the violations of the nonlinear constraints are sufficiently small, i.e., convergence condition
(18) (see the description of
in
Section 12.2) is satisfied.
- update_modified – Nag_Boolean
-
Nag_TRUE if the quasi-Newton update was modified to ensure that the Hessian is positive definite.
- qp_not_feasible – Nag_Boolean
-
Nag_TRUE if the QP subproblem has no feasible point.
- c_diff – Nag_Boolean
-
Nag_TRUE if central differences were used to compute the unspecified objective and constraint gradients.
- step_limit_exceeded – Nag_Boolean
-
Nag_TRUE if the line search produced a relative change in greater than the value defined by the optional argument .
- refactor – Nag_Boolean
-
Nag_TRUE if the approximate Hessian has been refactorized.
- x – double *
-
Contains the components of the current point , for .
- state – Integer *
-
Contains the status of the
variables,
linear, and
nonlinear constraints (if any). See
Section 12.2 for a description of the possible status values.
- ax – double *
-
If , contains the current value of the th linear constraint, for .
- cx – double *
-
If , contains the current value of nonlinear constraint , for .
- diagt – double *
-
If , the elements of the diagonal of the matrix .
- diagr – double *
-
Contains the elements of the diagonal of the upper triangular matrix .
If then the final result from nag_opt_nlin_lsq (e04unc) is provided through st. Note that will be called with only if , , , or . The following members of st are set:
- iter – Integer
-
The number of iterations performed.
- n – Integer
-
The number of variables.
- nclin – Integer
-
The number of linear constraints.
- ncnlin – Integer
-
The number of nonlinear constraints.
- x – double *
-
Contains the components of the final point , for .
- state – Integer *
-
Contains the status of the
variables,
linear, and
nonlinear constraints (if any). See
Section 12.2 for a description of the possible status values.
- ax – double *
-
If , contains the final value of the th linear constraint, for .
- cx – double *
-
If , contains the final value of nonlinear constraint , for .
- bl – double *
-
Contains the lower bounds on the variables.
- bu – double *
-
Contains the upper bounds on the variables.
- lambda – double *
-
Contains the final values of the Lagrange multipliers.
If then the results from derivative checking are provided through st. Note that will be called with only if or . The following members of st are set:
- m – Integer
-
The number of subfunctions.
- n – Integer
-
The number of variables.
- ncnlin – Integer
-
The number of nonlinear constraints.
- x – double *
-
Contains the components of the initial point , for .
- fjac – double *
-
Contains elements of the Jacobian of at the initial point ( is held at location , for and ).
- tdfjac – Integer
-
The trailing dimension of
fjac.
- conjac – double *
-
Contains the elements of the Jacobian matrix of nonlinear constraints at the initial point ( is held at location , for and ).
In this case the details of any derivative check performed by nag_opt_nlin_lsq (e04unc) are held in the following substructure of st:
- gprint – Nag_GPrintSt **
-
Which in turn contains three substructures
,
,
and two pointers to arrays of substructures,
and
.
- g_chk – Nag_Grad_Chk_St *
-
The substructure contains the members:
- type – Nag_GradChk
-
The type of derivative check performed by nag_opt_nlin_lsq (e04unc). This will be the same value as in .
- g_error – Integer
-
This member will be equal to one of the error codes NE_NOERROR or
NE_DERIV_ERRORS according to whether the derivatives were found to be correct or not.
- obj_start – Integer
-
Specifies the column of the objective Jacobian at which any component check started. This value will be equal to .
- obj_stop – Integer
-
Specifies the column of the objective Jacobian at which any component check ended. This value will be equal to .
- con_start – Integer
-
Specifies the element at which any component check of the constraint gradient started. This value will be equal to .
- con_stop – Integer
-
Specifies the element at which any component check of the constraint gradient ended. This value will be equal to .
- f_sim – Nag_SimSt *
-
The result of a simple derivative check of the objective gradient, , will be held in this substructure in members:
- n_elements – Integer
-
The number of columns of the objective Jacobian for which a simple check has been carried out, i.e., those columns which do not contain unknown elements.
- correct – Nag_Boolean
-
If Nag_TRUE then the objective Jacobian is consistent with the finite difference approximation according to a simple check.
- max_error – double
-
The maximum error found between the norm of a subfunction gradient and its finite difference approximation.
- max_subfunction – Integer
-
The subfunction which has the maximum error between its norm and its finite difference approximation.
- c_sim – Nag_SimSt *
-
The result of a simple derivative check of the constraint Jacobian, , will be held in this substructure in members:
- n_elements – Integer
-
The number of columns of the constraint Jacobian for which a simple check has been carried out, i.e., those columns which do not contain unknown elements.
- correct – Nag_Boolean
-
If Nag_TRUE then the Jacobian is consistent with the finite difference approximation according to a simple check.
- max_error – double
-
The maximum error found between the norm of a constraint gradient and its finite difference approximation.
- max_constraint – Integer
-
The constraint gradient which has the maximum error between its norm and its finite difference approximation.
- f_comp – Nag_CompSt **
-
The results of a requested component derivative check of the Jacobian of the objective function subfunctions,
, will be held in the array of
substructures of type Nag_CompSt pointed to by
. The element
will hold the details of the component derivative check for Jacobian element
, for
and
. The procedure for the derivative check is based on finding an interval that produces an acceptable estimate of the second derivative, and then using that estimate to compute an interval that should produce a reasonable forward-difference approximation. The Jacobian element is then compared with the difference approximation. (The method of finite difference interval estimation is based on
Gill et al. (1983).)
- correct – Nag_Boolean
-
If Nag_TRUE then this gradient element is consistent with its finite difference approximation.
- hopt – double
-
The optimal finite difference interval. This is
dx[i] in the default derivative checking printout (see
Section 12.3).
- gdiff – double
-
The finite difference approximation for this component.
- iter – Integer
-
The number of trials performed to find a suitable difference interval.
-
A character string which describes the possible nature of the reason for which an estimation of the finite difference interval failed to produce a satisfactory relative condition error of the second-order difference. Possible strings are: "Constant?", "Linear or odd?", "Too nonlinear?" and "Small derivative?".
- c_comp – Nag_CompSt **
-
The results of a requested component derivative check of the Jacobian of nonlinear constraint functions,
, will be held in the array of
substructures of type Nag_CompSt pointed to by
. The element
will hold the details of the component derivative check for Jacobian element
, for
and
. The procedure for the derivative check is based on finding an interval that produces an acceptable estimate of the second derivative, and then using that estimate to compute an interval that should produce a reasonable forward-difference approximation. The Jacobian element is then compared with the difference approximation. (The method of finite difference interval estimation is based on
Gill et al. (1983).)
The members of are as for .
The relevant members of the structure
comm are:
- g_prt – Nag_Boolean
-
Will be Nag_TRUE only when the print function is called with the result of the derivative check of
objfun and
confun.
- it_maj_prt – Nag_Boolean
-
Will be Nag_TRUE when the print function is called with information about the current major iteration.
- sol_sqp_prt – Nag_Boolean
-
Will be Nag_TRUE when the print function is called with the details of the final solution.
- it_prt – Nag_Boolean
-
Will be Nag_TRUE when the print function is called with information about the current minor iteration (i.e., an iteration of the current QP subproblem). See the documentation for
nag_opt_lin_lsq (e04ncc) for details of which members of
st are set.
- new_lm – Nag_Boolean
-
Will be Nag_TRUE when the Lagrange multipliers have been updated in a QP subproblem. See the documentation for
nag_opt_lin_lsq (e04ncc) for details of which members of
st are set.
- sol_prt – Nag_Boolean
-
Will be Nag_TRUE when the print function is called with the details of the solution of a QP subproblem, i.e., the solution at the end of a major iteration. See the documentation for
nag_opt_lin_lsq (e04ncc) for details of which members of
st are set.
- user – double *
- iuser – Integer *
- p – Pointer
-
Pointers for communication of user information. If used they must be allocated memory either before entry to nag_opt_nlin_lsq (e04unc) or during a call to
objfun,
confun or
. The type Pointer will be
void * with a C compiler that defines
void * and
char * otherwise.