NAG CPP Interface
nagcpp::opt::nlp1_solve (e04uc)

Note: this function uses optional parameters to define choices in the problem specification and in the details of the algorithm. If you wish to use default settings for all of the optional parameters, you need only read Sections 1 to 10 of this document. If, however, you wish to reset some or all of the settings please refer to Section 11 for a detailed description of the algorithm, to Section 12 for a detailed description of the specification of the optional parameters and to Section 13 for a detailed description of the monitoring information produced by the function.
Settings help

CPP Name Style:



1 Purpose

nlp1_solve is designed to minimize an arbitrary smooth 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.
nlp1_solve may also be used for unconstrained, bound-constrained and linearly constrained optimization.
nlp1_solve uses forward communication for evaluating the objective function, the nonlinear constraint functions, and any of their derivatives.

2 Specification

#include "e04/nagcpp_e04uc.hpp"
#include "e04/nagcpp_class_CommE04WB.hpp"
template <typename A, typename BL, typename BU, typename CONFUN, typename OBJFUN, typename ISTATE, typename C, typename CJAC, typename CLAMDA, typename OBJGRD, typename R, typename X, typename COMM>

void function nlp1_solve(const A &a, const BL &bl, const BU &bu, CONFUN &&confun, OBJFUN &&objfun, types::f77_integer &itera, ISTATE &&istate, C &&c, CJAC &&cjac, CLAMDA &&clamda, double &objf, OBJGRD &&objgrd, R &&r, X &&x, COMM &comm, OptionalE04UC opt)
template <typename A, typename BL, typename BU, typename CONFUN, typename OBJFUN, typename ISTATE, typename C, typename CJAC, typename CLAMDA, typename OBJGRD, typename R, typename X, typename COMM>

void function nlp1_solve(const A &a, const BL &bl, const BU &bu, CONFUN &&confun, OBJFUN &&objfun, types::f77_integer &itera, ISTATE &&istate, C &&c, CJAC &&cjac, CLAMDA &&clamda, double &objf, OBJGRD &&objgrd, R &&r, X &&x, COMM &comm)

3 Description

nlp1_solve is designed to solve the nonlinear programming problem – the minimization of a smooth nonlinear function subject to a set of constraints on the variables. The problem is assumed to be stated in the following form:
minimizexRn F(x)  subject to  l ( x ALx c(x) ) u, (1)
where F(x) (the objective function) is a nonlinear function, AL is an nL×n constant matrix, and c(x) is an nN element vector of nonlinear constraint functions. (The matrix AL and the vector c(x) 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 nlp1_solve 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 li=ui. If certain bounds are not present, the associated elements of l or u can be set to special values that will be treated as - or +. (See the description of the optional parameter Infinite Bound Size.)
If there are no nonlinear constraints in (1) and F is linear or quadratic, then it will generally be more efficient to use one of e04mff (no CPP interface), e04ncf (no CPP interface) and e04nff (no CPP interface), or e04nkf (no CPP interface) if the problem is large and sparse. If the problem is large and sparse and does have nonlinear constraints, then e04ugf (no CPP interface) should be used, since nlp1_solve treats all matrices as dense.
You must supply an initial estimate of the solution to (1), together with functions that define F(x), c(x) and as many first partial derivatives as possible; unspecified derivatives are approximated by finite differences.
The objective function is defined by objfun, and the nonlinear constraints are defined by confun. On every call, these functions must return appropriate values of the objective and nonlinear constraints. You should also provide the available partial derivatives. Any unspecified derivatives are approximated by finite differences; see Section 12.1 for a discussion of the optional parameter Derivative Level. 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 objfun and confun, the optional parameter Verify should be used to check the calculation of any known gradients.
The method used by nlp1_solve is described in detail in Section 11.
e04uff (no CPP interface) is an alternative function which uses exactly the same method, but uses reverse communication for evaluating the objective and constraint functions.

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 (1984a) Procedures for optimization problems with a mixture of bounds and general linear constraints ACM Trans. Math. Software 10 282–298
Gill P E, Murray W, Saunders M A and Wright M H (1984b) 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: a(nclin,:) double array Input
Note: the second dimension of a is given by: if nclin>0: n; otherwise: 1.
On entry: the ith row of a contains the ith row of the matrix AL of general linear constraints in (1). That is, the ith row contains the coefficients of the ith general linear constraint, for i=1,2,,nclin.
2: bl(n+nclin+ncnln) double array Input
On entry: bl must contain the lower bounds and bu the upper bounds for all the constraints in the following order. The first n elements of each array must contain the bounds on the variables, the next nL elements the bounds for the general linear constraints (if any) and the next nN elements the bounds for the general nonlinear constraints (if any). To specify a nonexistent lower bound (i.e., lj=-), set bl(j-1)-bigbnd, and to specify a nonexistent upper bound (i.e., uj=+), set bu(j-1)bigbnd; the default value of bigbnd is 1020, but this may be changed by the optional parameter Infinite Bound Size. To specify the jth constraint as an equality, set bl(j-1)=bu(j-1)=β, say, where |β|<bigbnd.
Constraints:
  • bl(j-1)bu(j-1), for j=1,2,,n+nclin+ncnln;
  • if bl(j-1)=bu(j-1)=β, |β|<bigbnd.
3: bu(n+nclin+ncnln) double array Input
On entry: bl must contain the lower bounds and bu the upper bounds for all the constraints in the following order. The first n elements of each array must contain the bounds on the variables, the next nL elements the bounds for the general linear constraints (if any) and the next nN elements the bounds for the general nonlinear constraints (if any). To specify a nonexistent lower bound (i.e., lj=-), set bl(j-1)-bigbnd, and to specify a nonexistent upper bound (i.e., uj=+), set bu(j-1)bigbnd; the default value of bigbnd is 1020, but this may be changed by the optional parameter Infinite Bound Size. To specify the jth constraint as an equality, set bl(j-1)=bu(j-1)=β, say, where |β|<bigbnd.
Constraints:
  • bl(j-1)bu(j-1), for j=1,2,,n+nclin+ncnln;
  • if bl(j-1)=bu(j-1)=β, |β|<bigbnd.
4: confun void function Function
confun must calculate the vector c(x) of nonlinear constraint functions and (optionally) its Jacobian (= c x ) for a specified n-element vector x. If there are no nonlinear constraints (i.e., ncnln=0), confun will never be called by nlp1_solve and confun may be the dummy function nlp1_​dummy_​confun. (nlp1_​dummy_​confun is included in the NAG Library.) If there are nonlinear constraints, the first call to confun will occur before the first call to objfun.
void function confun(const types::f77_integer mode, const utility::array1D<types::f77_integer,data_handling::ArgIntent::IN> &needc, const utility::array1D<double,data_handling::ArgIntent::IN> &x, utility::array1D<double,data_handling::ArgIntent::OUT> &c, utility::array2D<double,data_handling::ArgIntent::INOUT> &cjac, const types::f77_integer nstate)
1: mode types::f77_integer Input
On entry: indicates which values must be assigned during each call of confun. Only the following values need be assigned, for each value of i such that needc(i-1)>0:
mode=0
c(i-1).
mode=1
All available elements in the ith row of cjac.
mode=2
c(i-1) and all available elements in the ith row of cjac.
On exit: may be set to a negative value if you wish to terminate the solution to the current problem. In this case nlp1_solve will terminate with ifail set to mode.
2: needc(ncnln) types::f77_integer array Input
On entry: the indices of the elements of c and/or cjac that must be evaluated by confun. If needc(i-1)>0, the ith element of c and/or the available elements of the ith row of cjac (see argument mode) must be evaluated at x.
3: x(n) double array Input
On entry: x, the vector of variables at which the constraint functions and/or the available elements of the constraint Jacobian are to be evaluated.
4: c(ncnln) double array Output
On exit: if needc(i-1)>0 and mode=0 or 2, c(i-1) must contain the value of the ith constraint at x. The remaining elements of c, corresponding to the non-positive elements of needc, are ignored.
5: cjac(max(1,ncnln),n) double array Input/Output
On entry: unless Derivative Level=2 or 3, the elements of cjac are set to special values which enable nlp1_solve to detect whether they are changed by confun.
On exit: if needc(i-1)>0 and mode=1 or 2, the ith row of cjac must contain the available elements of the vector ci given by
ci= ( ci x1 , ci x2 ,, ci xn ) T,  
where ci xj is the partial derivative of the ith constraint with respect to the jth variable, evaluated at the point x. See also the argument nstate. The remaining rows of cjac, corresponding to non-positive elements of needc, are ignored.
If all elements of the constraint Jacobian are known (i.e., Derivative Level=2 or 3), any constant elements may be assigned to cjac one time only at the start of the optimization. An element of cjac that is not subsequently assigned in confun will retain its initial value throughout. Constant elements may be loaded into cjac either before the call to nlp1_solve or during the first call to confun (signalled by the value nstate=1). The ability to preload constants is useful when many Jacobian elements are identically zero, in which case cjac may be initialized to zero and nonzero elements may be reset by confun.
Note that constant nonzero elements do affect the values of the constraints. Thus, if cjac(i-1,j-1) is set to a constant value, it need not be reset in subsequent calls to confun, but the value cjac(i-1,j-1)×x(j-1) must nonetheless be added to c(i-1). For example, if cjac(0,0)=2 and cjac(0,1)=-5, then the term 2×x(0)-5×x(1) must be included in the definition of c(0).
It must be emphasized that, if Derivative Level=0 or 1, unassigned elements of cjac are not treated as constant; they are estimated by finite differences, at nontrivial expense. If you do not supply a value for the optional parameter Difference Interval, an interval for each element of x is computed automatically at the start of the optimization. The automatic procedure can usually identify constant elements of cjac, which are then computed once only by finite differences.
6: nstate types::f77_integer Input
On entry: if nstate=1, then nlp1_solve is calling confun for the first time. This argument setting allows you to save computation time if certain data must be read or calculated only once.
7: ncnln types::f77_integer Input
On entry: nN, the number of nonlinear constraints.
8: n types::f77_integer Input
On entry: n, the number of variables.
9: ldcj types::f77_integer Input
On entry: the first dimension of the array cjac as declared in the (sub)program from which nlp1_solve is called.
Note: confun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by nlp1_solve. If your code inadvertently does return any NaNs or infinities, nlp1_solve is likely to produce unexpected results.
confun should be tested separately before being used in conjunction with nlp1_solve. See also the description of the optional parameter Verify.
5: objfun void function Function
objfun must calculate the objective function F(x) and (optionally) its gradient g(x) = F x for a specified n-vector x.
void function objfun(const types::f77_integer mode, const utility::array1D<double,data_handling::ArgIntent::IN> &x, double &objf, utility::array1D<double,data_handling::ArgIntent::INOUT> &objgrd, const types::f77_integer nstate)
1: mode types::f77_integer Input
On entry: indicates which values must be assigned during each call of objfun. Only the following values need be assigned:
mode=0
objf.
mode=1
All available elements of objgrd.
mode=2
objf and all available elements of objgrd.
On exit: may be set to a negative value if you wish to terminate the solution to the current problem. In this case nlp1_solve will terminate with ifail set to mode.
2: x(n) double array Input
On entry: x, the vector of variables at which the objective function and/or all available elements of its gradient are to be evaluated.
3: objf double Output
On exit: if mode=0 or 2, objf must be set to the value of the objective function at x.
4: objgrd(n) double array Input/Output
On entry: the elements of objgrd are set to special values which enable nlp1_solve to detect whether they are changed by objfun.
On exit: if mode=1 or 2, objgrd must return the available elements of the gradient evaluated at x.
5: nstate types::f77_integer Input
On entry: if nstate=1, then nlp1_solve is calling objfun for the first time. This argument setting allows you to save computation time if certain data must be read or calculated only once.
6: n types::f77_integer Input
On entry: n, the number of variables.
Note: objfun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by nlp1_solve. If your code inadvertently does return any NaNs or infinities, nlp1_solve is likely to produce unexpected results.
objfun should be tested separately before being used in conjunction with nlp1_solve. See also the description of the optional parameter Verify.
6: itera types::f77_integer Output
On exit: the number of major iterations performed.
7: istate(n+nclin+ncnln) types::f77_integer array Input/Output
On entry: need not be set if the (default) optional parameter Cold Start is used.
If the optional parameter Warm Start has been chosen, the elements of istate corresponding to the bounds and linear constraints define the initial working set for the procedure that finds a feasible point for the linear constraints and bounds. The active set at the conclusion of this procedure and the elements of istate corresponding to nonlinear constraints then define the initial working set for the first QP subproblem. More precisely, the first n elements of istate refer to the upper and lower bounds on the variables, the next nL elements refer to the upper and lower bounds on ALx, and the next nN elements refer to the upper and lower bounds on c(x). Possible values for istate(j-1) are as follows:
istate(j-1) Meaning
0 The corresponding constraint is not in the initial QP working set.
1 This inequality constraint should be in the working set at its lower bound.
2 This inequality constraint should be in the working set at its upper bound.
3 This equality constraint should be in the initial working set. This value must not be specified unless bl(j-1)=bu(j-1).
The values -2, -1 and 4 are also acceptable but will be modified by the function. If nlp1_solve has been called previously with the same values of n, nclin and ncnln, istate already contains satisfactory information. The function also adjusts (if necessary) the values supplied in x to be consistent with istate.
Constraint: -2istate(j-1)4, for j=1,2,,n+nclin+ncnln.
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 istate(j-1) is as follows:
istate(j-1) Meaning
-2 This constraint violates its lower bound by more than the appropriate feasibility tolerance (see the optional parameters Linear Feasibility Tolerance and Nonlinear Feasibility Tolerance). This value can occur only when no feasible point can be found for a QP subproblem.
-1 This constraint violates its upper bound by more than the appropriate feasibility tolerance (see the optional parameters Linear Feasibility Tolerance and Nonlinear Feasibility Tolerance). This value can occur only when no feasible point can be found for a QP subproblem.
-0 The constraint is satisfied to within the feasibility tolerance, but is not in the QP working set.
-1 This inequality constraint is included in the QP working set at its lower bound.
-2 This inequality constraint is included in the QP working set at its upper bound.
-3 This constraint is included in the QP working set as an equality. This value of istate can occur only when bl(j-1)=bu(j-1).
8: c(ncnln) double array Output
On exit: if ncnln>0, c(i-1) contains the value of the ith nonlinear constraint function ci at the final iterate, for i=1,2,,ncnln.
If ncnln=0, c is not referenced and may be specified as nullptr.
9: cjac(ncnln,:) double array Input/Output
Note: the second dimension of cjac is given by: if ncnln>0: n; otherwise: 1.
On entry: in general, cjac need not be initialized before the call to nlp1_solve. However, if Derivative Level=2 or 3, you may optionally set the constant elements of cjac (see argument nstate in the description of confun). Such constant elements need not be re-assigned on subsequent calls to confun.
On exit: if ncnln>0, cjac contains the Jacobian matrix of the nonlinear constraint functions at the final iterate, i.e., cjac(i-1,j-1) contains the partial derivative of the ith constraint function with respect to the jth variable, for i=1,2,,ncnln and j=1,2,,n. (See the discussion of argument cjac under confun.)
If ncnln=0, cjac is not referenced and may be specified as nullptr.
10: clamda(n+nclin+ncnln) double array Input/Output
On entry: need not be set if the (default) optional parameter Cold Start is used.
If the optional parameter Warm Start has been chosen, clamda(j-1) must contain a multiplier estimate for each nonlinear constraint with a sign that matches the status of the constraint specified by the istate array, for j=n+nclin+1,,n+nclin+ncnln. The remaining elements need not be set. Note that if the jth constraint is defined as ‘inactive’ by the initial value of istate array (i.e., istate(j-1)=0), clamda(j-1) should be zero; if the jth constraint is an inequality active at its lower bound (i.e., istate(j-1)=1), clamda(j-1) should be non-negative; if the jth constraint is an inequality active at its upper bound (i.e., istate(j-1)=2), clamda(j-1) should be non-positive. If necessary, the function will modify clamda to match these rules.
On exit: the values of the QP multipliers from the last QP subproblem. clamda(j-1) should be non-negative if istate(j-1)=1 and non-positive if istate(j-1)=2.
11: objf double Output
On exit: the value of the objective function at the final iterate.
12: objgrd(n) double array Output
On exit: the gradient of the objective function at the final iterate (or its finite difference approximation).
13: r(n,n) double array Input/Output
On entry: need not be initialized if the (default) optional parameter Cold Start is used.
If the optional parameter Warm Start has been chosen, r must contain the upper triangular Cholesky factor R 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 r are assumed to be zero and need not be assigned.
On exit: if Hessian=NO, r contains the upper triangular Cholesky factor R of QTH~Q, an estimate of the transformed and reordered Hessian of the Lagrangian at x (see (6) in Section 11.1). If Hessian=YES, r contains the upper triangular Cholesky factor R of H, the approximate (untransformed) Hessian of the Lagrangian, with the variables in the natural order.
14: x(n) double array Input/Output
On entry: an initial estimate of the solution.
On exit: the final estimate of the solution.
15: comm CommE04WB Input/Output
Communication structure. This argument must have been initialized by a prior call to init (no CPP interface).
16: opt OptionalE04UC Input/Output
Optional parameter container, derived from Optional.

5.1Additional Quantities

1: n
n, the number of variables.
2: nclin
nL, the number of general linear constraints.
3: ncnln
nN, the number of nonlinear constraints.
4: ldcj
The first dimension of the array cjac.

6 Exceptions and Warnings

Errors or warnings detected by the function:
Note: in some cases nlp1_solve may return useful information.
All errors and warnings have an associated numeric error code field, errorid, stored either as a member of the thrown exception object (see errorid), or as a member of opt.ifail, depending on how errors and warnings are being handled (see Error Handling for more details).
Raises: CallbackEarlyTermination
errorid<0
User requested termination by setting mode negative in objfun or confun.
Raises: WarningException
errorid=1
Optimal solution found, but requested accuracy not achieved.
errorid=2
No feasible point for the linear constraints.
errorid=3
No feasible point for the nonlinear constraints.
errorid=4
Too many major iterations.
errorid=6
Current point cannot be improved upon.
Raises: ErrorException
errorid=7
Large errors found in the derivatives.
errorid=9
On entry, n = value.
Constraint: n>0.
errorid=9
On entry, nclin = value.
Constraint: nclin0.
errorid=9
On entry, ncnln = value.
Constraint: ncnln0.
errorid=9
On entry, the equal bounds on value are infinite, because
bl[value]=beta and bu[value]=beta,
but |beta|bigbnd: beta=value and
bigbnd=value.
errorid=9
On entry, the bounds on value are inconsistent:
bl[value]=value and
bu[value]=value.
errorid=9
On entry with a Warm Start,
istate[value]=value.
errorid=9
On entry, the equal bounds on variable value are
infinite, because bl[value]=beta and
bu[value]=beta, but |beta|bigbnd:
beta=value and bigbnd=value.
errorid=9
On entry, the equal bounds on linear constraint value are
infinite, because bl[value]=beta and
bu[value]=beta, but |beta|bigbnd:
beta=value and bigbnd=value.
errorid=9
On entry, the equal bounds on nonlinear constraint value
are infinite, because bl[value]=beta and
bu[value]=beta, but |beta|bigbnd:
beta=value and bigbnd=value.
errorid=9
On entry, the bounds on variable value are
inconsistent: bl[value]=value
and bu[value]=value.
errorid=9
On entry, the bounds on linear constraint value are
inconsistent: bl[value]=value
and bu[value]=value.
errorid=9
On entry, the bounds on nonlinear constraint value are
inconsistent: bl[value]=value
and bu[value]=value.
errorid=10601
On entry, argument value must be a vector of size value array.
Supplied argument has value dimensions.
errorid=10601
On entry, argument value must be a vector of size value array.
Supplied argument was a vector of size value.
errorid=10601
On entry, argument value must be a vector of size value array.
The size for the supplied array could not be ascertained.
errorid=10601
On entry, argument value must be a value x value array.
Supplied argument has value dimensions.
errorid=10601
On entry, argument value must be a value x value array.
Supplied argument was a value x value array.
errorid=10601
On entry, argument value must be a value x value array.
Not all of the sizes for the supplied array could be ascertained.
errorid=10602
On entry, the raw data component of value is null.
errorid=10603
On entry, unable to ascertain a value for value.
errorid=10604
On entry, the data in value is stored in value Major Order.
The data was expected to be in value Major Order.
errorid=10605
On entry, the communication class value has not been initialized correctly.
errorid=10703
An exception was thrown during IO (writing).
errorid=-99
An unexpected error has been triggered by this routine.
errorid=-399
Your licence key may have expired or may not have been installed correctly.
errorid=-999
Dynamic memory allocation failed.
Raises: CallbackException
errorid=10701
An exception was thrown in a callback.
errorid=10702
The memory address for an array in a callback has changed.

7 Accuracy

If errorid=0 on exit, then the vector returned in the array x is an estimate of the solution to an accuracy of approximately Optimality Tolerance (default value=ε0.8, where ε is the machine precision).

8 Parallelism and Performance

Please see the description for the underlying computational routine in this section of the FL Interface documentation.

9 Further Comments

9.1 Description of the Printed Output

This section describes the intermediate printout and final printout produced by nlp1_solve. The intermediate printout is a subset of the monitoring information produced by the function at every iteration (see Section 13). You can control the level of printed output (see the description of the optional parameter Major Print Level). Note that the intermediate printout and final printout are produced only if Major Print Level10 (the default for nlp1_solve, by default no output is produced by nlp1_solve).
The following line of summary output (<80 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 parameter Minor Iteration Limit if some iterations are required for the feasibility phase.
Step is the step αk taken along the computed search direction. On reasonably well-behaved problems, the unit step (i.e., αk=1) will be taken as the solution is approached.
Merit Function is the value of the augmented Lagrangian merit function (12) at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty parameters (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) then the merit function is a large multiple of the constraint violations, weighted by the penalty parameters. 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 nlp1_solve terminates with errorid=3 (no feasible point could be found for the nonlinear constraints).
If there are no nonlinear constraints present (i.e., ncnln=0) then this entry contains Objective, the value of the objective function F(x). The objective function will decrease monotonically to its optimal value when there are no nonlinear constraints.
Norm Gz is ZTgFR, the Euclidean norm of the projected gradient (see Section 11.2). Norm Gz will be approximately zero in the neighbourhood of a solution.
Violtn is the Euclidean norm of the residuals of constraints that are violated or in the predicted active set (not printed if ncnln is zero). Violtn 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 HZ ( HZ = ZT HFR Z = RZT RZ ; see (6)). The larger this number, the more difficult the problem.
M is printed if the quasi-Newton update has been 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 have been used to compute the unspecified objective and constraint gradients. If the value of Step is zero then the switch to central differences was made because no lower point could be found in the linesearch. (In this case, the QP subproblem is resolved with the central difference gradient and Jacobian.) If the value of Step is nonzero then central differences were computed because Norm Gz and Violtn imply that x is close to a Kuhn–Tucker point (see Section 11.1 in nlp1_​rcomm(_old) (no CPP interface in the current release)).
L is printed if the linesearch has produced a relative change in x greater than the value defined by the optional parameter Step Limit. If this output occurs frequently during later iterations of the run, optional parameter Step Limit should be set to a larger value.
R is printed if the approximate Hessian has been refactorized. If the diagonal condition estimator of R indicates that the approximate Hessian is badly conditioned then the approximate Hessian is refactorized using column interchanges. If necessary, R 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. A full stop (.) is printed for any numerical value that is zero.
Varbl gives the name (V) and index j, for j=1,2,,n, of the variable.
State gives the state of the variable (FR if neither bound is in the working set, EQ if a fixed variable, LL if on its lower bound, UL if on its upper bound, TF if temporarily fixed at its current value). If Value lies outside the upper or lower bounds by more than the Feasibility Tolerance, State will be ++ or -- respectively. (The latter situation can occur only when there is no feasible point for the bounds and linear constraints.)
A key is sometimes printed before State.
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 then 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 the Feasibility Tolerance.
Value is the value of the variable at the final iteration.
Lower Bound is the lower bound specified for the variable. None indicates that bl(j-1)-bigbnd.
Upper Bound is the upper bound specified for the variable. None indicates that bu(j-1)bigbnd.
Lagr Mult is the Lagrange multiplier for the associated bound. This will be zero if State is FR unless bl(j-1)-bigbnd and bu(j-1)bigbnd, in which case the entry will be blank. If x is optimal, the multiplier should be non-negative if State is LL and non-positive if State is UL.
Slack is the difference between the variable Value and the nearer of its (finite) bounds bl(j-1) and bu(j-1). A blank entry indicates that the associated variable is not bounded (i.e., bl(j-1)-bigbnd and bu(j-1)bigbnd).
The meaning of the printout for linear and nonlinear constraints is the same as that given above for variables, with ‘variable’ replaced by ‘constraint’, bl(j-1) and bu(j-1) are replaced by bl(n+j-1) and bu(n+j-1) respectively, and with the following changes in the heading:
L Con gives the name (L) and index j, for j=1,2,,nL, of the linear constraint.
N Con gives the name (N) and index (j-nL), for j=nL+1,,nL+nN, of the nonlinear constraint.
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 Slack column to become positive.
Numerical values are output with a fixed number of digits; they are not guaranteed to be accurate to this precision.

10 Example

This is based on Problem 71 in Hock and Schittkowski (1981) and involves the minimization of the nonlinear function
F(x)=x1x4(x1+x2+x3)+x3  
subject to the bounds
1x1 5 1x2 5 1x3 5 1x4 5  
to the general linear constraint
x1+x2+x3+x420,  
and to the nonlinear constraints
x12+x22+x32+x42 40, x1x2x3x4 25.  
The initial point, which is infeasible, is
x0=(1,5,5,1)T,  
and F(x0)=16.
The optimal solution (to five figures) is
x*=(1.0,4.7430,3.8211,1.3794)T,  
and F(x*)=17.014. One bound constraint and both nonlinear constraints are active at the solution.
The document for e04udf (no CPP interface) includes an example program to solve the same problem using some of the optional parameters described in Section 12.

10.1 Example Program

Source FileDataResults
ex_e04uc.cppNoneex_e04uc.r
Note: the remainder of this document is intended for more advanced users. Section 11 contains a detailed description of the algorithm which may be needed in order to understand Sections 12 and 13. Section 12 describes the optional parameters which may be set by calls to e04udf (no CPP interface) and nlp1_​option_​string(_old). Section 13 describes the quantities which can be requested to monitor the course of the computation.

11 Algorithmic Details

This section contains a detailed description of the method used by nlp1_solve.

11.1 Overview

nlp1_solve is essentially identical to the function 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 C denote the m×n matrix of gradients of the active general linear and nonlinear constraints. The number of fixed variables will be denoted by nFX, with nFR (nFR=n-nFX) 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 x is a first-order Kuhn–Tucker point for (1) (see Powell (1974)) if the following conditions hold:
  1. (i)x is feasible;
  2. (ii)there exist vectors ξ and λ (the Lagrange multiplier vectors for the bound and general constraints) such that
    g=CTλ+ξ (2)
    where g is the gradient of F evaluated at x, and ξj=0 if the jth variable is free.
  3. (iii)The Lagrange multiplier corresponding to an inequality constraint active at its lower bound must be non-negative, and non-positive for an inequality constraint active at its upper bound.
Let Z denote a matrix whose columns form a basis for the set of vectors orthogonal to the rows of CFR; i.e., CFRZ=0. An equivalent statement of the condition (2) in terms of Z is
ZTgFR=0.  
The vector ZTgFR is termed the projected gradient of F at x. Certain additional conditions must be satisfied in order for a first-order Kuhn–Tucker point to be a solution of (1) (see Powell (1974)).
nlp1_solve 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 nlp1_solve involves major and minor iterations. The major iterations generate a sequence of iterates {xk} that converge to x*, a first-order Kuhn–Tucker point of (1). At a typical major iteration, the new iterate x¯ is defined by
x¯=x+αp (3)
where x is the current iterate, the non-negative scalar α is the step length, and p 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 p in (3) is the solution of a quadratic programming subproblem of the form
minimizep gTp+ 12 pT Hp   subject to   l¯ { p ALp ANp } u¯, (4)
where g is the gradient of F at x, the matrix H is a positive definite quasi-Newton approximation to the Hessian of the Lagrangian function (see Section 11.4), and AN is the Jacobian matrix of c evaluated at x. (Finite difference estimates may be used for g and AN; see the optional parameter Derivative Level.) Let l in (1) be partitioned into three sections: lB, lL and lN, corresponding to the bound, linear and nonlinear constraints. The vector l¯ in (4) is similarly partitioned, and is defined as
l¯B=lB-x,  l¯L=lL-ALx,   and  l¯N=lN-c,  
where c is the vector of nonlinear constraints evaluated at x. The vector u¯ 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 monitoring file output of nlp1_solve; see Section 13.) In nlp1_solve, (4) is solved using e04ncf (no CPP interface). Since solving a quadratic program is itself an iterative procedure, the minor iterations of nlp1_solve are the iterations of e04ncf (no CPP interface). (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 C denote the m×n matrix of gradients of the general linear and nonlinear constraints in the predicted active set. First, we have available the TQ factorization of CFR:
CFRQFR= ( 0 T ) , (5)
where T is a nonsingular m×m reverse-triangular matrix (i.e., tij=0 if i+j<m), and the nonsingular nFR×nFR matrix QFR is the product of orthogonal transformations (see Gill et al. (1984b)). Second, we have the upper triangular Cholesky factor R of the transformed and reordered Hessian matrix
RTR=HQQTH~Q, (6)
where H~ is the Hessian H with rows and columns permuted so that the free variables are first, and Q is the n×n matrix
Q= ( QFR IFX ) (7)
with IFX the identity matrix of order nFX. If the columns of QFR are partitioned so that
QFR= ( Z Y ) ,  
the nZ (nZnFR-m) columns of Z form a basis for the null space of CFR. The matrix Z is used to compute the projected gradient ZTgFR at the current iterate. (The values Nz and Norm Gz printed by nlp1_solve give nZ and ZTgFR; see Section 13.)
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 x*. In nlp1_solve, 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 nlp1_solve also saves computation in factorizing CFR and HQ.
Once p 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 HQ is updated using a modified BFGS quasi-Newton update (see Section 11.4) to incorporate new curvature information obtained in the move from x to x¯.
On entry to nlp1_solve, an iterative procedure from e04ncf (no CPP interface) is executed, starting with the user-supplied initial point, to find a point that is feasible with respect to the bounds and linear constraints (using the tolerance specified by optional parameter Linear Feasibility Tolerance). If no feasible point exists for the bound and linear constraints, (1) has no solution and nlp1_solve 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 optional parameter Difference Interval). 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-supplied gradients appear to be correct (see the description of the optional parameter Verify). 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 nlp1_solve first determines a point that satisfies the bound and linear constraints. Thereafter, each iteration includes:
  1. (a)the solution of a quadratic programming subproblem;
  2. (b)a linesearch with an augmented Lagrangian merit function; and
  3. (c)a quasi-Newton update of the approximate Hessian of the Lagrangian function.
These three procedures are described in more detail in Sections 11.2 to 11.4.

11.2 Solution of the Quadratic Programming Subproblem

The search direction p is obtained by solving (4) using e04ncf (no CPP interface) (see Gill et al. (1986)), which was specifically designed to be used within an SQP algorithm for nonlinear programming.
e04ncf (no CPP interface) is based on 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 functions. 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 p denote the current estimate of the solution of (4); the new iterate p¯ is defined by
p¯=p+σd (8)
where, as in (3), σ is a non-negative step length and d is a search direction.
At the beginning of each iteration of e04ncf (no CPP interface), a working set is defined of constraints (general and bound) that are satisfied exactly. The vector d is then constructed so that the values of constraints in the working set remain unaltered for any move along d. For a bound constraint in the working set, this property is achieved by setting the corresponding element of d 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 C denote the sub-matrix of rows of
( AL AN )  
corresponding to general constraints in the working set. The general constraints in the working set will remain unaltered if
CFRdFR=0, (9)
which is equivalent to defining dFR as
dFR=ZdZ (10)
for some vector dZ, where Z is the matrix associated with the TQ factorization (5) of CFR.
The definition of dZ in (10) depends on whether the current p is feasible. If not, dZ is zero except for an element γ in the jth position, where j and γ are chosen so that the sum of infeasibilities is decreasing along d. (For further details, see Gill et al. (1986).) In the feasible case, dZ satisfies the equations
RZT RZ dZ = - ZT qFR , (11)
where RZ is the Cholesky factor of ZTHFRZ and q is the gradient of the quadratic objective function (q=g+Hp). (The vector ZTqFR is the projected gradient of the QP.) With (11), p+d 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 p 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 μj corresponding to an inequality constraint in the working set is said to be optimal if μjδ when the jth constraint is at its upper bound, or if μj-δ when the associated constraint is at its lower bound. If any multiplier is nonoptimal, 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 μj will satisfy -(1+δ)μjδ for an inequality constraint at its upper bound, and -δμj(1+δ) for an inequality at its lower bound. The Lagrange multiplier for an equality constraint will satisfy |μj|1+δ.
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 p+d is feasible, σ will be taken as unity. (In this case, the projected gradient at p¯ will be zero.) Otherwise, σ is set to σM, 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 CFR: if the status of a general constraint changes, a row of CFR is altered; if a bound constraint enters or leaves the working set, a column of CFR changes. Explicit representations are recurred of the matrices T, QFR and R, and of the vectors QTq and QTg.

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
L (x,λ,s) = F(x) - i λi (ci(x)-si) + 12 i ρi (ci(x)-si) 2 , (12)
where x, λ and s 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 {si} 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 parameters 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 13) is generally nondecreasing, although each ρi 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 H 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 H¯ is defined as a rank-two modification of H. In nlp1_solve, the BFGS (Broyden–Fletcher–Goldfarb–Shanno) quasi-Newton update is used:
H¯=H-1sTHs HssTH+1yTs yyT, (13)
where s=x¯-x (the change in x).
In nlp1_solve, H is required to be positive definite. If H is positive definite, H¯ defined by (13) will be positive definite if and only if yTs is positive (see Dennis and Moré (1977)). Ideally, y in (13) would be taken as yL, the change in gradient of the Lagrangian function
yL = g¯ - A¯NT μN - g + ANT μN , (14)
where μN denotes the QP multipliers associated with the nonlinear constraints of the original problem. If yLT s is not sufficiently positive, an attempt is made to perform the update with a vector y of the form
y=yL+i=1mNωi(ai(x^)ci(x^)-ai(x)ci(x)),  
where ωi0. If no such vector can be found, the update is performed with a scaled yL; in this case, M is printed to indicate that the update was modified.
Rather than modifying H itself, the Cholesky factor of the transformed Hessian HQ (6) is updated, where Q is the matrix from (5) associated with the active set of the QP subproblem. The update (13) is equivalent to the following update to HQ:
H¯Q = HQ - 1 sQT HQ sQ HQ sQ sQT HQ + 1 yQT sQ yQ yQT , (15)
where yQ=QTy, and sQ=QTs. This update may be expressed as a rank-one update to R (see Dennis and Schnabel (1981)).

12 Optional Parameters

Several optional parameters in nlp1_solve define choices in the problem specification or the algorithm logic. In order to reduce the number of formal arguments of nlp1_solve these optional parameters have associated default values that are appropriate for most problems. Therefore, you need only specify those optional parameters whose values are to be different from their default values.
The remainder of this section can be skipped if you wish to use the default values for all optional parameters.
The following is a list of the optional parameters available. A full description of each optional parameter is provided in Section 12.1.
Optional parameters may be specified by calling one, or both, of e04udf (no CPP interface) and nlp1_​option_​string(_old) before a call to nlp1_solve.
e04udf (no CPP interface) reads options from an external options file, with Begin and End as the first and last lines respectively and each intermediate line defining a single optional parameter. For example,
Begin 
  Print level = 1 
End
A call to nlp1_​option_​file(_old) can then be used to read the file.
nlp1_​option_​string(_old) can be called to supply options directly, one call being necessary for each optional parameter.
All optional parameters not specified by you are set to their default values. Optional parameters specified by you are unaltered by nlp1_solve (unless they define invalid values) and so remain in effect for subsequent calls to nlp1_solve, unless altered by you.

12.1 Description of the Optional Parameters

For each option, we give a summary line, a description of the optional parameter and details of constraints.
The summary line contains:
Keywords and character values are case and white space insensitive.
Central Difference IntervalrDefault values are computed
If the algorithm switches to central differences because the forward-difference approximation is not sufficiently accurate, the value of r is used as the difference interval for every element of x. 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 9.1). The use of finite differences is discussed further under the optional parameter Difference Interval.
If you supply a value for this optional parameter, a small value between 0.0 and 1.0 is appropriate.
Cold Start Default
Warm Start
This option controls the specification of the initial working set in both the procedure for finding a feasible point for the linear constraints and bounds and in the first QP subproblem thereafter. With a Cold Start, the first working set is chosen by nlp1_solve 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 Crash Tolerance).
With a Warm Start, you must set the istate array and define clamda and r as discussed in Section 5. istate 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. istate values associated with nonlinear constraints determine the initial working set of the first QP subproblem after such a feasible point has been found. nlp1_solve will override your specification of istate if necessary, so that a poor choice of the working set will not cause a fatal error. For instance, any elements of istate which are set to -2, -1 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 nlp1_solve is called repeatedly to solve related problems.
Crash TolerancerDefault =0.01
This value is used in conjunction with the optional parameter Cold Start (the default value) when nlp1_solve selects an initial working set. If 0r1, the initial working set will include (if possible) bounds or general inequality constraints that lie within r of their bounds. In particular, a constraint of the form ajT xl will be included in the initial working set if |ajTx-l| r (1+|l|) . If r<0 or r>1, the default value is used.
Defaults
This special keyword may be used to reset all optional parameters to their default values.
Derivative LeveliDefault =3
This parameter indicates which derivatives are provided in user-supplied functions objfun and confun. The possible choices for i are the following.
i Meaning
3 All elements of the objective gradient and the constraint Jacobian are provided.
2 All elements of the constraint Jacobian are provided, but some elements of the objective gradient are not specified.
1 All elements of the objective gradient are provided, but some elements of the constraint Jacobian are not specified.
0 Some elements of both the objective gradient and the constraint Jacobian are not specified.
The value i=3 should be used whenever possible, since nlp1_solve is more reliable (and will usually be more efficient) when all derivatives are exact.
If i=0 or 2, nlp1_solve will estimate the unspecified elements of the objective gradient, 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 Chapter 8 of Gill et al. (1981), for a discussion of limiting accuracy).
If i=0 or 1, nlp1_solve 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 Jacobian has the form
( * * * * * ? ? * * * ? * * * * * ) 
where ‘*’ indicates an element provided by you and ‘?’ indicates an unspecified element, nlp1_solve 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 objfun and confun are needed. (The switch to central differences is not under your control.)
If i<0 or i>3, the default value is used.
Difference IntervalrDefault values are computed
This option defines an interval used to estimate derivatives by finite differences in the following circumstances:
  1. (a)For verifying the objective and/or constraint gradients (see the description of the optional parameter Verify).
  2. (b)For estimating unspecified elements of the objective gradient or the constraint Jacobian.
In general, a derivative with respect to the jth variable is approximated using the interval δj, where δj=r(1+|x^j|), with x^ 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(r). See 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 nlp1_solve determine constant elements in the objective and constraint gradients (see the descriptions of confun and objfun in Section 5).
If you supply a value for this optional parameter, a small value between 0.0 and 1.0 is appropriate.
Feasibility TolerancerDefault =ε
The scalar r defines the maximum acceptable absolute violations in linear and nonlinear constraints at a ‘feasible’ point; i.e., a constraint is considered satisfied if its violation does not exceed r. If r<ε or r1, the default value is used. Using this keyword sets both optional parameters Linear Feasibility Tolerance and Nonlinear Feasibility Tolerance to r, if εr<1. (Additional details are given under the descriptions of these optional parameters.)
Function PrecisionrDefault =ε0.9
This parameter defines εr, which is intended to be a measure of the accuracy with which the problem functions F(x) and c(x) can be computed. If r<ε or r1, the default value is used.
The value of εr should reflect the relative precision of 1+|F(x)|; i.e., εr acts as a relative precision when |F| is large and as an absolute precision when |F| is small. For example, if F(x) is typically of order 1000 and the first six significant digits are known to be correct, an appropriate value for εr would be 10-6. In contrast, if F(x) is typically of order 10-4 and the first six significant digits are known to be correct, an appropriate value for εr would be 10-10. The choice of εr 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 εr should be large enough so that nlp1_solve will not attempt to distinguish between function values that differ by less than the error inherent in the calculation.
HessianYes/NoDefault =NO
This option controls the contents of the upper triangular matrix R (see Section 5). nlp1_solve works exclusively with the transformed and reordered Hessian HQ (6), and hence extra computation is required to form the Hessian itself. If Hessian=NO, r contains the Cholesky factor of the transformed and reordered Hessian. If Hessian=YES, the Cholesky factor of the approximate Hessian itself is formed and stored in r. You should select Hessian=YES if a Warm Start will be used for the next call to nlp1_solve.
Infinite Bound SizerDefault =1020
If r>0, r defines the ‘infinite’ bound bigbnd in the definition of the problem constraints. Any upper bound greater than or equal to bigbnd will be regarded as + (and similarly any lower bound less than or equal to -bigbnd will be regarded as -). If r<0, the default value is used.
Infinite Step SizerDefault =max(bigbnd,1020)
If r>0, r specifies the magnitude of the change in variables that is treated as a step to an unbounded solution. If the change in x during an iteration would exceed the value of r, the objective function is considered to be unbounded below in the feasible region. If r0, the default value is used.
Line Search TolerancerDefault =0.9
The value r (0r<1) 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 r, the more accurate the linesearch). The default value r=0.9 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. If r<0 or r1, the default value is used.
Linear Feasibility Tolerancer1Default =ε
Nonlinear Feasibility Tolerancer2Default =ε0.33 or ε
The default value of r2 is ε0.33 if Derivative Level=0 or 1, and ε otherwise.
The scalars r1 and r2 define the maximum acceptable absolute violations in linear and nonlinear constraints at a ‘feasible’ point; i.e., a linear constraint is considered satisfied if its violation does not exceed r1, and similarly for a nonlinear constraint and r2. If rm<ε or rm1, the default value is used, for m=1,2.
On entry to nlp1_solve, 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 r1. All subsequent iterates will satisfy the linear constraints to within the same tolerance (unless r1 is comparable to the finite difference interval).
For nonlinear constraints, the feasibility tolerance r2 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 optional parameter Nonlinear Feasibility Tolerance acts as a partial termination criterion for the iterative sequence generated by nlp1_solve (see the discussion of optional parameter Optimality Tolerance).
These tolerances should reflect the precision of the corresponding 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 r1 as 10-6.
List Default for nlp1_solve
Nolist Default for nlp1_solve
Optional parameter List enables printing of each optional parameter specification as it is supplied. Nolist suppresses this printing.
Major Iteration LimitiDefault =max(50,3(n+nL)+10nN)
Iteration Limiti
Itersi
Itnsi
The value of i specifies the maximum number of major iterations allowed before termination. Setting i=0 and Major Print Level>0 means that the workspace needed will be computed and printed, but no iterations will be performed. If i<0, the default value is used.
Major Print LeveliDefault for nlp1_solve =10
Print LeveliDefault for nlp1_solve =0
The value of i controls the amount of printout produced by the major iterations of nlp1_solve, as indicated below. A detailed description of the printed output is given in Section 9.1 (summary output at each major iteration and the final solution) and Section 13 (monitoring information at each major iteration). (See also the description of the optional parameter Minor Print Level.)
The following printout is sent to the current advisory message unit (as defined by register_to_advisory_message_unit):
i Output
00 No output.
01 The final solution only.
05 One line of summary output (<80 characters; see Section 9.1) for each major iteration (no printout of the final solution).
10 The final solution and one line of summary output for each major iteration.
The following printout is sent to the unit number given by the optional parameter Monitoring File:
i Output
<5 No output.
5 One long line of output (>80 characters; see Section 13) for each major iteration (no printout of the final solution).
20 At each major iteration, the objective function, the Euclidean norm of the nonlinear constraint violations, the values of the nonlinear constraints (the vector c), the values of the linear constraints (the vector ALx), and the current values of the variables (the vector x).
30 At each major iteration, the diagonal elements of the matrix T associated with the TQ factorization (5) (see Section 11.1) of the QP working set, and the diagonal elements of R, the triangular factor of the transformed and reordered Hessian (6) (see Section 11.1).
If Major Print Level5 and the unit number defined by the optional parameter Monitoring File is the same as that defined by x04abf (no CPP interface), the summary output for each major iteration is suppressed.
Minor Iteration LimitiDefault =max(50,3(n+nL+nN))
The value of i specifies the maximum number of iterations for finding a feasible point with respect to the bounds and linear constraints (if any). The value of i also specifies the maximum number of minor iterations for the optimality phase of each QP subproblem. If i0, the default value is used.
Minor Print LeveliDefault =0
The value of i controls the amount of printout produced by the minor iterations of nlp1_solve (i.e., the iterations of the quadratic programming algorithm), as indicated below. A detailed description of the printed output is given in Section 9.1 (summary output at each minor iteration and the final QP solution) and Section 13 in lsq_​lincon_​solve(_old) (no CPP interface in the current release) (monitoring information at each minor iteration). (See also the description of the optional parameter Major Print Level.)
The following printout is sent to the current advisory message unit (as defined by register_to_advisory_message_unit):
i Output
00 No output.
01 The final QP solution only.
05 One line of summary output (<80 characters; see Section 9.2 in lsq_​lincon_​solve(_old) (no CPP interface in the current release)) for each minor iteration (no printout of the final QP solution).
10 The final QP solution and one line of summary output for each minor iteration.
The following printout is sent to the unit number given by the optional parameter Monitoring File:
i Output
<5 No output.
5 One long line of output (>80 characters; see Section 9.2 in lsq_​lincon_​solve(_old) (no CPP interface in the current release)) for each minor iteration (no printout of the final QP solution).
20 At each minor iteration, the current estimates of the QP multipliers, the current estimate of the QP search direction, the QP constraint values, and the status of each QP constraint.
30 At each minor iteration, the diagonal elements of the matrix T associated with the TQ factorization (5) (see Section 11.1) of the QP working set, and the diagonal elements of the Cholesky factor R of the transformed Hessian (6) (see Section 11.1).
If Major Print Level5 and the unit number defined by the optional parameter Monitoring File is the same as that defined by x04abf (no CPP interface), the summary output for each major iteration is suppressed.
Monitoring FileiDefault =-1
If i0 and Major Print Level5 or i0 and Minor Print Level5, monitoring information produced by nlp1_solve at every iteration is sent to a file with logical unit number i. If i<0 and/or Major Print Level<5 and Minor Print Level<5, no monitoring information is produced.
Optimality TolerancerDefault =εr0.8
The parameter r (εrr<1) specifies the accuracy to which you wish the final iterate to approximate a solution of the problem. Broadly speaking, r indicates the number of correct figures desired in the objective function at the solution. For example, if r is 10-6 and nlp1_solve terminates successfully, the final value of F should have approximately six correct figures. If r<εr or r1, the default value is used.
nlp1_solve will terminate successfully if the iterative sequence of x 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 x if
αpr(1+x), (16)
where p is the search direction and α the step length from (3). An iterate is considered to satisfy the first-order conditions for a minimum if
Z T g FR r (1+max( 1 + |F(x)| , g FR )) (17)
and
|resj|ftol  for all  j, (18)
where ZTgFR is the projected gradient (see Section 11.1), gFR is the gradient of F(x) with respect to the free variables, resj is the violation of the jth active nonlinear constraint, and ftol is the Nonlinear Feasibility Tolerance.
Start Objective Check At Variablei1Default =1
Stop Objective Check At Variablei2Default =n
Start Constraint Check At Variablei3Default =1
Stop Constraint Check At Variablei4Default =n
These keywords take effect only if Verify Level>0. They may be used to control the verification of gradient elements computed by objfun and/or Jacobian elements computed by confun. For example, if the first 30 elements of the objective gradient appeared to be correct in an earlier run, so that only element 31 remains questionable, it is reasonable to specify Start Objective Check At Variable=31. If the first 30 variables appear linearly in the objective, so that the corresponding gradient elements are constant, the above choice would also be appropriate.
If i2m-10 or i2m-1>min(n,i2m), the default value is used, for m=1,2. If i2m0 or i2m>n, the default value is used, for m=1,2.
Step LimitrDefault =2.0
If r>0,r specifies the maximum change in variables at the first step of the linesearch. In some cases, such as F(x)=aebx or F(x)=axb, even a moderate change in the elements of x can lead to floating-point overflow. The parameter r is, therefore, used to encourage evaluation of the problem functions at meaningful points. Given any major iterate x, the first point x~ at which F and c are evaluated during the linesearch is restricted so that
x~-x2r(1+x2).  
The linesearch may go on and evaluate F and c at points further from x if this will result in a lower value of the merit function (indicated by L at the end of each line of output produced by the major iterations; see Section 9.1). If L is printed for most of the iterations, r should be set to a larger value.
Wherever possible, upper and lower bounds on x should be used to prevent evaluation of nonlinear functions at wild values. The default value Step Limit=2.0 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 Step Limit is selected, a good starting point may be required. An important application is to the class of nonlinear least squares problems. If r0, the default value is used.
Verify LeveliDefault =0
Verify
Verify Constraint Gradients
Verify Gradients
Verify Objective Gradients
These keywords refer to finite difference checks on the gradient elements computed by objfun and confun. The possible choices for i are as follows:
i Meaning
-1 No checks are performed.
-0 Only a ‘cheap’ test will be performed.
1 Individual gradient elements will also be checked using a reliable (but more expensive) test.
It is possible to specify Verify Level=0 to 3 in several ways. For example, the nonlinear objective gradient (if any) will be verified if either Verify Objective Gradients or Verify Level=1 is specified. The constraint gradients will be verified if Verify=YES or Verify Level=2 or Verify is specified. Similarly, the objective and the constraint gradients will be verified if Verify=YES or Verify Level=3 or Verify is specified.
If 0i3, gradients will be verified at the first point that satisfies the linear constraints and bounds.
If i=0, only a ‘cheap’ test will be performed, requiring one call to objfun and (if appropriate) one call to confun.
If 1i3, a more reliable (but more expensive) check will be made on individual gradient elements, within the ranges specified by the Start Constraint Check At Variable and Stop Constraint Check At Variable keywords. A result of the form OK or BAD? is printed by nlp1_solve to indicate whether or not each element appears to be correct. If a gradient element is determined to be extremely poor (i.e., if it appears to have no significant digits of accuracy at all), then nlp1_solve will also exit with an error indicator in argument ifail.
If 10i13, the action is the same as for i-10, except that it will take place at the user-specified initial value of x.
If i<-1 or 4i9 or i>13, the default value is used.
We suggest that Verify Level=3 be used whenever a new function function is being developed.

13 Description of Monitoring Information

This section describes the long line of output (>80 characters) which forms part of the monitoring information produced by nlp1_solve. (See also the description of the optional parameters Major Print Level, Minor Print Level and Monitoring File.) You can control the level of printed output.
When Major Print Level5 and Monitoring File0, the following line of output is produced at every major iteration of nlp1_solve on the unit number specified by Monitoring File. 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 parameter Minor Iteration Limit if some iterations are required for the feasibility phase.
Step is the step αk taken along the computed search direction. On reasonably well-behaved problems, the unit step (i.e., αk=1) will be taken as the solution is approached.
Nfun is the cumulative number of evaluations of the objective function needed for the linesearch. 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.
Merit Function is the value of the augmented Lagrangian merit function (12) at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty parameters (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) then the merit function is a large multiple of the constraint violations, weighted by the penalty parameters. 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 nlp1_solve terminates with errorid=3 (no feasible point could be found for the nonlinear constraints).
If there are no nonlinear constraints present (i.e., ncnln=0) then this entry contains Objective, the value of the objective function F(x). The objective function will decrease monotonically to its optimal value when there are no nonlinear constraints.
Norm Gz is ZTgFR, the Euclidean norm of the projected gradient (see Section 11.2). Norm Gz will be approximately zero in the neighbourhood of a solution.
Violtn is the Euclidean norm of the residuals of constraints that are violated or in the predicted active set (not printed if ncnln is zero). Violtn will be approximately zero in the neighbourhood of a solution.
Nz is the number of columns of Z (see Section 11.2). The value of Nz is the number of variables minus the number of constraints in the predicted active set; i.e., Nz=n-(Bnd+Lin+Nln).
Bnd is the number of simple bound constraints in the predicted active set.
Lin is the number of general linear constraints in the predicted working set.
Nln is the number of nonlinear constraints in the predicted active set (not printed if ncnln is zero).
Penalty is the Euclidean norm of the vector of penalty parameters used in the augmented Lagrangian merit function (not printed if ncnln is zero).
Cond H is a lower bound on the condition number of the Hessian approximation H.
Cond Hz is a lower bound on the condition number of the projected Hessian approximation HZ ( HZ = ZT HFR Z = RZT RZ ; see (6)). The larger this number, the more difficult the problem.
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 parameter Optimality Tolerance. Each letter is T if the test is satisfied and F otherwise. The three tests indicate whether:
  1. (i)the sequence of iterates has converged;
  2. (ii)the projected gradient (Norm Gz) is sufficiently small; and
  3. (iii)the norm of the residuals of constraints in the predicted active set (Violtn) is small enough.
If any of these indicators is F when nlp1_solve terminates with errorid=0, you should check the solution carefully.
M is printed if the quasi-Newton update has been 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 have been used to compute the unspecified objective and constraint gradients. If the value of Step is zero then the switch to central differences was made because no lower point could be found in the linesearch. (In this case, the QP subproblem is resolved with the central difference gradient and Jacobian.) If the value of Step is nonzero then central differences were computed because Norm Gz and Violtn imply that x is close to a Kuhn–Tucker point (see Section 11.1 in nlp1_​rcomm(_old) (no CPP interface in the current release)).
L is printed if the linesearch has produced a relative change in x greater than the value defined by the optional parameter Step Limit. If this output occurs frequently during later iterations of the run, optional parameter Step Limit should be set to a larger value.
R is printed if the approximate Hessian has been refactorized. If the diagonal condition estimator of R indicates that the approximate Hessian is badly conditioned then the approximate Hessian is refactorized using column interchanges. If necessary, R is modified so that its diagonal condition estimator is bounded.