nag_opt_nlp (e04ucc) (PDF version)
e04 Chapter Contents
e04 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_opt_nlp (e04ucc)

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_opt_nlp (e04ucc) 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. You should supply as many first derivatives as possible; any unspecified derivatives are approximated by finite differences. It is not intended for large sparse problems.
nag_opt_nlp (e04ucc) may also be used for unconstrained, bound-constrained and linearly constrained optimization.

2  Specification

#include <nag.h>
#include <nage04.h>
void  nag_opt_nlp (Integer n, Integer nclin, Integer ncnlin, const double a[], Integer tda, const double bl[], const double bu[],
void (*objfun)(Integer n, const double x[], double *objf, double g[], Nag_Comm *comm),
void (*confun)(Integer n, Integer ncnlin, const Integer needc[], const double x[], double conf[], double conjac[], Nag_Comm *comm),
double x[], double *objf, double g[], Nag_E04_Opt *options, Nag_Comm *comm, NagError *fail)

3  Description

nag_opt_nlp (e04ucc) 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:
minimize x R n F x   subject to   l x A L x c x u , (1)
where F x  (the objective function) is a nonlinear function, A L  is an n L  by n  constant matrix, and c x  is an n N  element vector of nonlinear constraint functions. (The matrix A L  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 nag_opt_nlp (e04ucc) 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 l i = u i . 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 argument options.inf_bound in Section 11.2.)
If there are no nonlinear constraints in (1) and F  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 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 function objfun, and the nonlinear constraints are defined by function 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 11.2 for a discussion of the optional arguments options.obj_deriv and options.con_deriv. Just before either objfun or confun is called, each element of the current gradient array g 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 if you 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 options.verify_grad (see Section 11.2) should be used to check the calculation of any known gradients.
The method used by nag_opt_nlp (e04ucc) is described in detail in Section 10.

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 (1984a) 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 (1984b) 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 (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
Murtagh B A and Saunders M A (1983) MINOS 5.0 user's guide Report SOL 83-20 Department of Operations Research, Stanford University
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:     nIntegerInput
On entry: n , the number of variables.
Constraint: n>0 .
2:     nclinIntegerInput
On entry: n L , the number of general linear constraints.
Constraint: nclin0 .
3:     ncnlinIntegerInput
On entry: n N , the number of nonlinear constraints.
Constraint: ncnlin0 .
4:     a[nclin×tda]const doubleInput
On entry: the i th row of a must contain the coefficients of the i th general linear constraint (the i th row of the matrix A L  in (1)). The ijth element of AL must be stored in a[i-1×tda+j-1], for i=1,2,, n L .
If nclin=0  then the array a is not referenced.
5:     tdaIntegerInput
On entry: the stride separating matrix column elements in the array a.
Constraint: if nclin>0 , tdan
6:     bl[n+nclin+ncnlin]const doubleInput
7:     bu[n+nclin+ncnlin]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 n  elements of each array must contain the bounds on the variables, the next n L  elements the bounds for the general linear constraints (if any), and the next n N  elements the bounds for the nonlinear constraints (if any). To specify a nonexistent lower bound (i.e., l j = - ), set bl[j-1] -options.inf_bound , and to specify a nonexistent upper bound (i.e., u j = + ), set bu[j-1] options.inf_bound, where options.inf_bound is one of the optional arguments (default value 10 20 , see Section 11.2). To specify the j th constraint as an equality, set bl[j-1] = bu[j-1] = β , say, where β < options.inf_bound.
Constraints:
  • bl[j-1] bu[j-1] , for j=1,2,, n + nclin + ncnlin ;
  • if bl[j-1] = bu[j-1] = β , β < options.inf_bound .
8:     objfunfunction, supplied by the userExternal Function
objfun must calculate the objective function F x  and (optionally) its gradient g x = F xj  for a specified n  element vector x .
The specification of objfun is:
void  objfun (Integer n, const double x[], double *objf, double g[], Nag_Comm *comm)
1:     nIntegerInput
On entry: n , the number of variables.
2:     x[n]const doubleInput
On entry: x , the vector of variables at which the value of F  and/or all available elements of its gradient are to be evaluated.
3:     objfdouble *Output
On exit: if commflag = 0  or 2, objfun must set objf to the value of the objective function F  at the current point x . If it is not possible to evaluate F  then objfun should assign a negative value to commflag ; nag_opt_nlp (e04ucc) will then terminate.
4:     g[n]doubleOutput
On exit: if commflag = 2 , g must contain the elements of the vector g x  given by
g x = F x1 , F x2 ,, F xn T ,
where F xi  is the partial derivative of the objective function with respect to the i th variable evaluated at the point x  , for i=1,2,,n.
If the optional argument options.obj_deriv=Nag_TRUE  (the default), all elements of g must be set; if options.obj_deriv=Nag_FALSE , any available elements of the vector g x  must be assigned to the elements of g; the remaining elements must remain unchanged.
5:     commNag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to objfun.
flagIntegerInput/Output
On entry: objfun is called with commflag  set to 0 or 2.
If commflag = 0  then only objf is referenced.
If commflag = 2  then both objf and g are referenced.
On exit: if objfun resets commflag  to some negative number then nag_opt_nlp (e04ucc) will terminate immediately with the error indicator NE_USER_STOP. If fail is supplied to nag_opt_nlp (e04ucc), fail.errnum will be set to your setting of commflag .
firstNag_BooleanInput
On entry: will be set to Nag_TRUE on the first call to objfun and Nag_FALSE for all subsequent calls.
nfIntegerInput
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.
userdouble *
iuserInteger *
pPointer 
The type Pointer will be void * with a C compiler that defines void * and char * otherwise.
Before calling nag_opt_nlp (e04ucc) these pointers may be allocated memory and initialized with various quantities for use by objfun when called from nag_opt_nlp (e04ucc).
Note: objfun should be tested separately before being used in conjunction with nag_opt_nlp (e04ucc). The optional arguments options.verify_grad and options.max_iter 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 gradient elements then the optional argument options.obj_deriv should be set to Nag_FALSE.
9:     confunfunction, supplied by the userExternal 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., ncnlin=0 ), confun will never be called and the NAG defined null void function pointer, NULLFN, can be supplied in the call to nag_opt_nlp (e04ucc). If there are nonlinear constraints the first call to confun will occur before the first call to objfun.
The specification of confun is:
void  confun (Integer n, Integer ncnlin, const Integer needc[], const double x[], double conf[], double conjac[], Nag_Comm *comm)
1:     nIntegerInput
On entry: n , the number of variables.
2:     ncnlinIntegerInput
On entry: n N , 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 needc[i-1] > 0  then the i th element of conf and/or the available elements of the i th row of conjac (see argument commflag  below) must be evaluated at x .
4:     x[n]const doubleInput
On entry: the vector of variables x  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 needc[i-1] > 0  and commflag = 0  or 2, conf[i-1]  must contain the value of the i th constraint at x . The remaining elements of conf, corresponding to the non-positive elements of needc, are ignored.
6:     conjac[ncnlin×n]doubleOutput
On exit: if needc[i-1] > 0  and commflag = 2 , the i th row of conjac (i.e., the elements conjac[ i-1 × n + j - 1 ] , for j=1,2,,n) must contain the available elements of the vector c i  given by
c i = ci x1 , ci x2 ,, ci xn T ,
where ci xj  is the partial derivative of the i th constraint with respect to the j th variable, evaluated at the point x . The remaining rows of conjac, corresponding to non-positive elements of needc, are ignored.
If the optional argument options.con_deriv=Nag_TRUE  (the default), all elements of conjac must be set; if options.con_deriv=Nag_FALSE , then any available partial derivatives of c i x  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., options.con_deriv=Nag_TRUE ; see Section 11.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 commfirst = Nag_TRUE.
It must be emphasized that, if options.con_deriv=Nag_FALSE , 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 options.f_diff_int (the default; see Section 11.2), 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 conjac, which are then computed once only by finite differences.
7:     commNag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to confun.
flagIntegerInput/Output
On entry: confun is called with commflag  set to 0 or 2.
If commflag = 0  then only conf is referenced.
If commflag = 2  then both conf and conjac are referenced.
On exit: if confun resets commflag  to some negative number then nag_opt_nlp (e04ucc) will terminate immediately with the error indicator NE_USER_STOP. If fail is supplied to nag_opt_nlp (e04ucc) fail.errnum will be set to your setting of commflag .
firstNag_BooleanInput
On entry: will be set to Nag_TRUE on the first call to confun and Nag_FALSE for all subsequent calls.
userdouble *
iuserInteger *
pPointer 
The type Pointer will be void * with a C compiler that defines void * and char * otherwise.
Before calling nag_opt_nlp (e04ucc) these pointers may be allocated memory and initialized with various quantities for use by confun when called from nag_opt_nlp (e04ucc).
Note: confun should be tested separately before being used in conjunction with nag_opt_nlp (e04ucc). The optional arguments options.verify_grad and options.max_iter can be used to assist this process. The array x must not be changed by confun.
If confun does not calculate all of the elements of the constraint gradients then the optional argument options.con_deriv should be set to Nag_FALSE.
10:   x[n]doubleInput/Output
On entry: an initial estimate of the solution.
On exit: the final estimate of the solution.
11:   objfdouble *Output
On exit: the value of the objective function at the final iterate.
12:   g[n]doubleOutput
On exit: the gradient of the objective function at the final iterate (or its finite difference approximation).
13:   optionsNag_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_nlp (e04ucc). 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 11. Some of the results returned in options can be used by nag_opt_nlp (e04ucc) to perform a ‘warm start’ (see the member options.start in Section 11.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) immediately before being supplied as an argument to nag_opt_nlp (e04ucc).
14:   commNag_Comm *Input/Output
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 11.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_nlp (e04ucc); comm will then be declared internally for use in calls to user-supplied functions.
15:   failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

5.1  Description of the Printed Output

Intermediate and final results are printed out by default. The level of printed output can be controlled with the structure members options.print_level and options.minor_print_level (see Section 11.2). The default setting of options.print_level=Nag_Soln_Iter and options.minor_print_level=Nag_NoPrint provides a single line of output at each iteration and the final result. This section describes the default printout produced by nag_opt_nlp (e04ucc).
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 10).
Note that Mnr may be greater than the optional argument options.minor_max_iter (default value = max50, 3 n + n L + n N ; see Section 11.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 (12) at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty arguments (see Section 10.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_nlp (e04ucc) terminates with fail.code=NW_NONLIN_NOT_FEASIBLE  (no feasible point could be found for the nonlinear constraints).
If no nonlinear constraints are present (i.e., ncnlin=0 ), 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.
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 ZT g FR , the Euclidean norm of the projected gradient (see Section 10.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 H Z    H Z = ZT H FR Z = RZT R Z ; 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 10.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 x  is close to a Kuhn–Tucker point (see Section 10.1).
L is printed if the line search has produced a relative change in x  greater than the value defined by the optional argument options.step_limit (default value =2.0 ; see Section 11.2). If this output occurs frequently during later iterations of the run, options.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, 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.
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 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 options.lin_feas_tol and options.nonlin_feas_tol (see Section 11.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 options.lin_feas_tol.
Value is the value of the variable at the final iteration.
Lower bound is the lower bound specified for the variable j . (None indicates that bl[j-1] options.inf_bound, where options.inf_bound is the optional argument.)
Upper bound is the upper bound specified for the variable j . (None indicates that bu[j-1] options.inf_bound, where options.inf_bound 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 bl[j-1] -options.inf_bound  and bu[j-1] options.inf_bound, 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.
Residual 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] -options.inf_bound  and bu[j-1] options.inf_bound).
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,, n L , of the linear constraint.
N Con gives the name (N) and index j-n L , for j = n L + 1 , n L + 2 , , n L + n N  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 options.lin_feas_tol and for nonlinear constraints which violate one of their bounds by more than options.nonlin_feas_tol.
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, tda=value  while n=value . These arguments must satisfy tdan .
This error message is output only if nclin>0 .
NE_2_INT_OPT_ARG_CONS
On entry, options.con_check_start=value  while options.con_check_stop=value .
Constraint: options.con_check_startoptions.con_check_stop .
On entry, options.obj_check_start=value  while options.obj_check_stop=value .
Constraint: options.obj_check_startoptions.obj_check_stop .
NE_ALLOC_FAIL
Dynamic memory allocation failed.
NE_BAD_PARAM
On entry, argument options.minor_print_level had an illegal value.
On entry, argument options.print_deriv had an illegal value.
On entry, argument options.print_level had an illegal value.
On entry, argument options.start had an illegal value.
On entry, argument options.verify_grad had an illegal value.
NE_BOUND
The lower bound for variable value (array element bl[value] ) is greater than the upper bound.
NE_BOUND_EQ
The lower bound and upper bound for variable value (array elements bl[value]  and bu[value] ) are equal but they are greater than or equal to options.inf_bound.
NE_BOUND_EQ_LCON
The lower bound and upper bound for linear constraint value (array elements bl[value]  and bu[value] ) are equal but they are greater than or equal to options.inf_bound.
NE_BOUND_EQ_NLCON
The lower bound and upper bound for nonlinear constraint value (array elements bl[value]  and bu[value] ) are equal but they are greater than or equal to options.inf_bound.
NE_BOUND_LCON
The lower bound for linear constraint value (array element bl[value] ) is greater than the upper bound.
NE_BOUND_NLCON
The lower bound for nonlinear constraint value (array element bl[value] ) 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 x=0  or x=1  are used to test function evaluation procedures, and how often the special properties of these numbers make the test meaningless.
Gradient checking will be ineffective if the objective function uses information computed by the constraints, since they are not necessarily computed prior to each function evaluation.
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, n=value.
Constraint: n1.
On entry, nclin=value.
Constraint: nclin0.
On entry, ncnlin=value.
Constraint: ncnlin0.
NE_INT_OPT_ARG_GT
On entry, options.con_check_start=value .
Constraint: options.con_check_startn .
On entry, options.con_check_stop=value .
Constraint: options.con_check_stopn .
On entry, options.obj_check_start=value .
Constraint: options.obj_check_startn .
On entry, options.obj_check_stop=value .
Constraint: options.obj_check_stopn .
NE_INT_OPT_ARG_LT
On entry, options.con_check_start=value .
Constraint: options.con_check_start1 .
On entry, options.con_check_stop=value .
Constraint: options.con_check_stop1 .
On entry, options.obj_check_start=value .
Constraint: options.obj_check_start1 .
On entry, options.obj_check_stop=value .
Constraint: options.obj_check_stop1 .
NE_INVALID_INT_RANGE_1
Value value given to options.max_iter not valid. Correct range is options.max_iter0 .
Value value given to options.minor_max_iter not valid. Correct range is options.minor_max_iter0 .
NE_INVALID_REAL_RANGE_EF
Value value given to options.c_diff_int not valid. Correct range is ε options.c_diff_int < 1.0 .
Value value given to options.f_diff_int not valid. Correct range is ε options.f_diff_int < 1.0 .
Value value given to options.f_prec not valid. Correct range is ε options.f_prec < 1.0 .
Value value given to options.lin_feas_tol not valid. Correct range is ε options.lin_feas_tol < 1.0 .
Value value given to options.nonlin_feas_tol not valid. Correct range is ε options.nonlin_feas_tol < 1.0 .
Value value given to options.optim_tol not valid. Correct range is options.f_prec options.optim_tol < 1.0 .
NE_INVALID_REAL_RANGE_F
Value value given to options.inf_bound not valid. Correct range is options.inf_bound>0.0 .
Value value given to options.inf_step not valid. Correct range is options.inf_step>0.0 .
Value value given to options.step_limit not valid. Correct range is options.step_limit>0.0 .
NE_INVALID_REAL_RANGE_FF
Value value given to options.crash_tol not valid. Correct range is 0.0 options.crash_tol 1.0 .
Value value given to options.linesearch_tol not valid. Correct range is 0.0 options.linesearch_tol < 1.0 .
NE_NOT_APPEND_FILE
Cannot open file string  for appending.
NE_NOT_CLOSE_FILE
Cannot close file string .
NE_OPT_NOT_INIT
Options structure not initialized.
NE_STATE_VAL
options.state[value]  is out of range. options.state[value] = value.
NE_USER_STOP
User requested termination, user flag value =value .
This exit occurs if you set commflag  to a negative value in objfun or confun. If fail is supplied the value of fail.errnum will be the same as your setting of commflag .
NE_WRITE_ERROR
Error occurred when writing to file string .
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 in Section 10.1, and the merit function is described in Section 10.3 and Section 11.3.
This sometimes occurs because an overly stringent accuracy has been requested, i.e., the value of the optional argument options.optim_tol (default value = ε r 0.8 , where ε r  is the relative precision of F x ; see Section 11.2) is too small. In this case you should apply the four tests described in Section 8.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_nlp (e04ucc) has failed completely to move from the initial point then functions objfun and/or confun may be incorrect. You should refer to comments under fail.code=NE_DERIV_ERRORS  and check the gradients using the optional argument options.verify_grad (default value options.verify_grad=Nag_SimpleCheck; see Section 11.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_nlp (e04ucc) from the final point with the optional argument options.start=Nag_Warm (see Section 11.2). In this situation, the optional arguments options.state and options.lambda should be left unaltered and R  (in optional argument options.h) 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 11.3), it may be helpful to run nag_opt_nlp (e04ucc) with a relaxed value of the optional arguments options.lin_feas_tol and options.nonlin_feas_tol (default values ε , ε 0.33  or ε , respectively, where ε  is the machine precision; see Section 11.2). (Constraint dependencies are often indicated by wide variations in size in the diagonal elements of the matrix T , whose diagonals will be printed if options.print_level=Nag_Soln_Iter_Full (default value options.print_level=Nag_Soln_Iter; see Section 11.2).)
NW_LIN_NOT_FEASIBLE
No feasible point was found for the linear constraints and bounds.
nag_opt_nlp (e04ucc) 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 options.lin_feas_tol (default value = ε , where ε  is the machine precision; see Section 11.2), or no feasible point could be found in the number of iterations specified by the optional argument options.minor_max_iter (default value = max50, 3 n + n L + n N ; see Section 11.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 options.lin_feas_tol is greater than σ . For example, if all elements of A L  are of order unity and are accurate to only three decimal places, options.lin_feas_tol should be at least 10 -3 .
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 options.state. If you are convinced that a feasible point does exist, nag_opt_nlp (e04ucc) 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 x  satisfies the first-order Kuhn–Tucker conditions (see Section 10.1) to the accuracy requested, but the sequence of iterates has not yet converged. nag_opt_nlp (e04ucc) was terminated because no further improvement could be made in the merit function (see Section 11.3).
This value of fail.code 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 options.f_prec (default value = ε 0.9 , where ε  is the machine precision; see Section 11.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 8.1 are satisfied then x  is likely to be a solution of (1) even if fail.code=NW_NOT_CONVERGED .
NW_OVERFLOW_WARN
Serious ill conditioning in the working set after adding constraint value. 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 options.lin_feas_tol (default value = ε , where ε  is the machine precision; see Section 11.2) and/or the optional argument options.nonlin_feas_tol (default value ε 0.33  or ε ; see Section 11.2), and rerunning the program. If the message recurs even after this change, the offending linearly dependent constraint j  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 l j  and u j ).
NW_TOO_MANY_ITER
The maximum number of iterations, value, have been performed.
The value of the optional argument options.max_iter 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 the optional argument options.max_iter and rerun nag_opt_nlp (e04ucc); alternatively, rerun nag_opt_nlp (e04ucc), setting the optional argument options.start=Nag_Warm 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 under fail.code=NW_KT_CONDITIONS .
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 R  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 line of output; see Section 5.1), it may be worthwhile setting options.start=Nag_Warm and calling nag_opt_nlp (e04ucc) from the final point.

7  Accuracy

If fail.code=NE_NOERROR  on exit, then the vector returned in the array x is an estimate of the solution to an accuracy of approximately options.optim_tol (default value = ε r 0.8 , where ε r  is the relative precision of F x ; see Section 11.2).

8  Further Comments

8.1  Termination Criteria

The function exits with fail.code=NE_NOERROR  if iterates have converged to a point x  that satisfies the Kuhn–Tucker conditions (see Section 10.1) to the accuracy requested by the optional argument options.optim_tol (default value = ε r 0.8 , see Section 11.2).
You should also examine the printout from nag_opt_nlp (e04ucc) (see Section 5.1 or Section 11.3) 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, x  is almost certainly a local minimum.

9  Example

This example is based on Problem 71 in Hock and Schittkowski (1981) and involves the minimization of the nonlinear function
F x = x 1 x 4 x 1 + x 2 + x 3 + x 3
subject to the bounds
1 x 1 5 1 x 2 5 1 x 3 5 1 x 4 5
to the general linear constraint
x 1 + x 2 + x 3 + x 4 20 ,
and to the nonlinear constraints
x 1 2 + x 2 2 + x 3 2 + x 4 2 40 , x 1 x 2 x 3 x 4 25 .
The initial point, which is infeasible, is
x 0 = 1,5,5,1T ,
and F x 0 = 16 .
The optimal solution (to five figures) is
x * = 1.0,4.7430,3.8211,1.3794T ,
and F x * = 17.014 . One bound constraint and both nonlinear constraints are active at the solution.
The options structure is declared and initialized by nag_opt_init (e04xxc). Two options are read from the data file by use of nag_opt_read (e04xyc). nag_opt_nlp (e04ucc) is then called to solve the problem using the function objfun and confun with elements of the objective gradient not being set at all and only some of the elements of the constraint Jacobian being provided. 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.

9.1  Program Text

Program Text (e04ucce.c)

9.2  Program Data

Program Data (e04ucce.d)

Program Options (e04ucce.opt)

9.3  Program Results

Program Results (e04ucce.r)

10  Further Description

This section gives a detailed description of the algorithm used in nag_opt_nlp (e04ucc). This, and possibly the next section, Section 11, may be omitted if the more sophisticated features of the algorithm and software are not currently of interest.

10.1  Overview

nag_opt_nlp (e04ucc) 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 C  denote the m  by n  matrix of gradients of the active general linear and nonlinear constraints. The number of fixed variables will be denoted by n FX , with n FR   n FR = n - n FX  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, e.g., Powell (1974)) if the following conditions hold:
(i) x  is feasible;
(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 j 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 Z  denote a matrix whose columns form a basis for the set of vectors orthogonal to the rows of C FR ; i.e., C FR Z = 0 . An equivalent statement of the condition (2) in terms of Z  is
ZT g FR = 0 .
The vector ZT g FR  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, e.g., Powell (1974)). nag_opt_nlp (e04ucc) 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_nlp (e04ucc) involves major and minor iterations. The major iterations generate a sequence of iterates x k  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
Minimize p gT p + 1 2 pT Hp   subject to   l - p A L p A N p 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 10.4), and A N  is the Jacobian matrix of c  evaluated at x . (Finite difference estimates may be used for g  and A N ; see the optional arguments options.obj_deriv and options.con_deriv in Section 11.2.) Let l  in (1) be partitioned into three sections: l B , l L  and l N , corresponding to the bound, linear and nonlinear constraints. The vector l -  in (4) is similarly partitioned, and is defined as
l - B = l B - x , l - L = l L - A L x , and ​ l - N = l N - 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 output of nag_opt_nlp (e04ucc); see Section 11.3.) In nag_opt_nlp (e04ucc), (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_nlp (e04ucc) are the iterations of nag_opt_lin_lsq (e04ncc). (More details about solving the subproblem are given in Section 10.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  by n  matrix of gradients of the general linear and nonlinear constraints in the predicted active set. First, we have available the TQ  factorization of C FR :
C FR Q FR = 0 T , (5)
where T  is a non-singular m  by m  reverse-triangular matrix (i.e., t ij = 0  if i + j < m , and the non-singular n FR  by n FR  matrix Q FR  is the product of orthogonal transformations (see Gill et al. (1984a)). Second, we have the upper triangular Cholesky factor R  of the transformed and re-ordered Hessian matrix
RT R = H Q QT H ~ 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  by n  matrix
Q = Q FR I FX (7)
with I FX  the identity matrix of order n FX . If the columns of Q FR  are partitioned so that
Q FR = Z Y ,
the n Z    n Z n FR - m  columns of Z  form a basis for the null space of C FR . The matrix Z  is used to compute the projected gradient ZT g FR  at the current iterate. (The values Nz, Norm Gf and Norm Gz printed by nag_opt_nlp (e04ucc) give n Z  and the norms of g FR  and ZT g FR ; see Section 11.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 x * . In nag_opt_nlp (e04ucc), 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_nlp (e04ucc) also saves computation in factorizing C FR  and H Q .
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 10.3). Finally, the approximation to the transformed Hessian matrix H Q  is updated using a modified BFGS quasi-Newton update (see Section 10.4) to incorporate new curvature information obtained in the move from x  to x - .
On entry to nag_opt_nlp (e04ucc), an iterative procedure from nag_opt_lin_lsq (e04ncc) is executed, starting with the initial point you provided, to find a point that is feasible with respect to the bounds and linear constraints (using the tolerance specified by options.lin_feas_tol; see Section 11.2). If no feasible point exists for the bound and linear constraints, (1) has no solution and nag_opt_nlp (e04ucc) 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 options.f_diff_int in Section 11.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 gradients you provided appear to be correct (see the optional argument options.verify_grad in Section 11.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_nlp (e04ucc) 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 10.2);
(b) a linesearch with an augmented Lagrangian merit function (see Section 10.3); and
(c) a quasi-Newton update of the approximate Hessian of the Lagrangian function (Section 10.4).

10.2  Solution of the Quadratic Programming Subproblem

The search direction p  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 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 nag_opt_lin_lsq (e04ncc), 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
A L A N
corresponding to general constraints in the working set. The general constraints in the working set will remain unaltered if
C FR d FR = 0 (9)
which is equivalent to defining d FR  as
d FR = Zd Z (10)
for some vector d Z , where Z  is the matrix associated with the TQ  factorization (5) of C FR .
The definition of d Z  in (10) depends on whether the current p  is feasible. If not, d Z  is zero except for an element γ  in the j th 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, d Z  satisfies the equations
RZT R Z d Z = - ZT q FR (11)
where R Z  is the Cholesky factor of ZT H FR Z  and q  is the gradient of the quadratic objective function q = g + Hp . (The vector ZT q FR  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 at its upper bound is said to be optimal if μ j δ  when the j th constraint is at its upper bound, or if μ j -δ  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 μ 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 C FR : if the status of a general constraint changes, a row of C FR  is altered; if a bound constraint enters or leaves the working set, a column of C FR  changes. Explicit representations are recurred of the matrices T , Q FR  and R , and of the vectors QT q  and QT g .

10.3  The Merit Function

After computing the search direction as described in Section 10.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 c i x - s i + 1 2 i ρ i c i x - s i 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 s i  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 11.3) is generally non-decreasing, 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).

10.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 nag_opt_nlp (e04ucc), the BFGS quasi-Newton update is used:
H - = H - 1 sT Hs HssT H + 1 yT s yyT , (13)
where s = x - - x  (the change in x ).
In nag_opt_nlp (e04ucc), H  is required to be positive definite. If H  is positive definite, H -  defined by (13) will be positive definite if and only if yT s  is positive (see, e.g., Dennis and Moré (1977)). Ideally, y  in (13) would be taken as y L , the change in gradient of the Lagrangian function
y L = 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 = y L + i ω i a i x - c i x - - a i x c i x ,
where ω i 0 . If no such vector can be found, the update is performed with a scaled y L ; 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 H Q  (6) is updated, where Q  is the matrix from (5) associated with the active set of the QP subproblem. The update (12) is equivalent to the following update to H Q :
H - Q = H Q - 1 sQT H Q s Q H Q s Q sQT H Q + 1 yQT s Q y Q yQT , (15)
where y Q = QT y , and s Q = QT s . This update may be expressed as a rank-one update to R  (see Dennis and Schnabel (1981)).

11  Optional Arguments

A number of optional input and output arguments to nag_opt_nlp (e04ucc) 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_nlp (e04ucc); 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, this must be done directly in the calling program; they cannot be assigned using nag_opt_read (e04xyc).

11.1  Optional Argument Checklist and Default Values

For easy reference, the following list shows the members of options which are valid for nag_opt_nlp (e04ucc) together with their default values where relevant. The number ε  is a generic notation for machine precision (see nag_machine_precision (X02AJC)).
Nag_Start start Nag_Cold
Boolean list Nag_TRUE
Nag_PrintType print_level Nag_Soln_Iter
Nag_PrintType minor_print_level Nag_NoPrint
char outfile[80] stdout
void (*print_fun)() NULL
Boolean obj_deriv Nag_TRUE
Boolean con_deriv Nag_TRUE
Nag_GradChk verify_grad Nag_SimpleCheck
Nag_DPrintType print_deriv Nag_D_Full
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 max50, 3 n+nclin + 10 ncnlin
Integer minor_max_iter max50, 3 n + nclin + ncnlin
double f_prec ε 0.9
double optim_tol options.f_prec 0.8
double lin_feas_tol ε
double nonlin_feas_tol ε 0.33  or ε
double linesearch_tol 0.9
double step_limit 2.0
double crash_tol 0.01
double inf_bound 10 20
double inf_step maxoptions.inf_bound, 10 20
double *conf size ncnlin
double *conjac size ncnlin*n
Integer *state size n + nclin + ncnlin
double *lambda size n + nclin + ncnlin
double *h size n*n
Boolean hessian Nag_FALSE
Integer iter
Integer nf

11.2  Description of the Optional Arguments

start – Nag_StartDefault =Nag_Cold
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 options.start=Nag_Cold, nag_opt_nlp (e04ucc) 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 optional argument options.crash_tol; see below).
With options.start=Nag_Warm, you must provide a valid definition of every array element of the optional arguments options.state, options.lambda and options.h (see below for their definitions). The options.state 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 options.state 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_nlp (e04ucc) will override your specification of options.state if necessary, so that a poor choice of the working set will not cause a fatal error. For instance, any elements of options.state 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 nag_opt_nlp (e04ucc) is called repeatedly to solve related problems.
Constraint: options.start=Nag_Cold or Nag_Warm.
list – Nag_BooleanDefault =Nag_TRUE
On entry: if options.list=Nag_TRUE  the argument settings in the call to nag_opt_nlp (e04ucc) will be printed.
print_level – Nag_PrintTypeDefault =Nag_Soln_Iter
On entry: the level of results printout produced by nag_opt_nlp (e04ucc) at each major iteration. The following values are available:
Nag_NoPrintNo output.
Nag_SolnThe final solution only.
Nag_IterOne line of output for each iteration.
Nag_Iter_LongA longer line of output for each iteration with more information (line exceeds 80 characters).
Nag_Soln_IterThe final solution and one line of output for each iteration.
Nag_Soln_Iter_LongThe final solution and one long line of output for each iteration (line exceeds 80 characters).
Nag_Soln_Iter_ConstAs Nag_Soln_Iter_Long with the objective function, the values of the variables, the Euclidean norm of the nonlinear constraint violations, the nonlinear constraint values, c , and the linear constraint values A L x  also printed at each iteration.
Nag_Soln_Iter_FullAs Nag_Soln_Iter_Const with the diagonal elements of the upper triangular matrix T  associated with the TQ  factorization (5) of the QP working set, and the diagonal elements of R , the triangular factor of the transformed and re-ordered Hessian (6).
Details of each level of results printout are described in Section 11.3.
Constraint: options.print_level=Nag_NoPrint, Nag_Soln, Nag_Iter, Nag_Soln_Iter, Nag_Iter_Long, Nag_Soln_Iter_Long, Nag_Soln_Iter_Const or Nag_Soln_Iter_Full.
minor_print_level – Nag_PrintTypeDefault =Nag_NoPrint
On entry: the level of results printout produced by the minor iterations of nag_opt_nlp (e04ucc) (i.e., the iterations of the QP subproblem). The following values are available:
Nag_NoPrintNo output.
Nag_SolnThe final solution only.
Nag_IterOne line of output for each iteration.
Nag_Iter_LongA longer line of output for each iteration with more information (line exceeds 80 characters).
Nag_Soln_IterThe final solution and one line of output for each iteration.
Nag_Soln_Iter_LongThe final solution and one long line of output for each iteration (line exceeds 80 characters).
Nag_Soln_Iter_ConstAs Nag_Soln_Iter_Long with the Lagrange multipliers, the variables x , the constraint values A L x  and the constraint status also printed at each iteration.
Nag_Soln_Iter_FullAs Nag_Soln_Iter_Const with the diagonal elements of the upper triangular matrix T  associated with the TQ  factorization (4) of the working set, and the diagonal elements of the upper triangular matrix R  printed at each iteration.
Details of each level of results printout are described in Section 11 in nag_opt_lin_lsq (e04ncc). (options.minor_print_level in the present function is equivalent to options.print_level.)
Constraint: options.minor_print_level=Nag_NoPrint, Nag_Soln, Nag_Iter, Nag_Soln_Iter, Nag_Iter_Long, Nag_Soln_Iter_Long, Nag_Soln_Iter_Const or Nag_Soln_Iter_Full.
outfile – const char[80]Default =stdout
On entry: the name of the file to which results should be printed. If options.outfile[0] = ' \0 '  then the stdout stream is used.
print_fun – pointer to functionDefault = NULL
On entry: printing function defined by you; the prototype of options.print_fun is
void (*print_fun)(const Nag_Search_State *st, Nag_Comm *comm);
See Section 11.3.1 for further details.
obj_deriv – Nag_BooleanDefault =Nag_TRUE
On entry: this argument indicates whether you have provided all the derivatives of the objective function in objfun. If none or only some of the derivatives are being supplied by objfun then options.obj_deriv should be set to Nag_FALSE.
Whenever possible you should supply all derivatives, since nag_opt_nlp (e04ucc) is more reliable and will usually be more efficient when all derivatives are exact.
If options.obj_deriv=Nag_FALSE , nag_opt_nlp (e04ucc) will approximate the unspecified components 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. (1986b), 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_BooleanDefault =Nag_TRUE
On entry: this argument indicates whether you have provided all derivatives for the constraint Jacobian in confun. If none or only some of the derivatives are being supplied by confun then options.con_deriv should be set to Nag_FALSE.
Whenever possible you should supply all derivatives, since nag_opt_nlp (e04ucc) is more reliable and will usually be more efficient when all derivatives are exact.
If options.con_deriv=Nag_FALSE , nag_opt_nlp (e04ucc) will approximate unspecified elements of the 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_nlp (e04ucc) 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_GradChkDefault =Nag_SimpleCheck
On entry: specifies the level of derivative checking to be performed by nag_opt_nlp (e04ucc) on the gradient elements computed by objfun and confun.
The following values are available:
Nag_NoCheckNo derivative checking is performed.
Nag_SimpleCheckPerform a simple check of both the objective and constraint gradients.
Nag_CheckObjPerform a component check of the objective gradient elements.
Nag_CheckConPerform a component check of the constraint gradient elements.
Nag_CheckObjConPerform a component check of both the objective and constraint gradient elements.
Nag_XSimpleCheckPerform a simple check of both the objective and constraint gradients at the initial value of x  specified in x.
Nag_XCheckObjPerform a component check of the objective gradient elements at the initial value of x  specified in x.
Nag_XCheckConPerform a component check of the constraint gradient elements at the initial value of x  specified in x.
Nag_XCheckObjConPerform a component check of both the objective and constraint gradient elements at the initial value of x  specified in x.
If options.verify_grad=Nag_SimpleCheck or Nag_XSimpleCheck then a simple ‘cheap’ test is performed, which requires only one call to objfun and one call to confun. If options.verify_grad=Nag_CheckObj, Nag_CheckCon or Nag_CheckObjCon 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 arguments options.obj_check_start and options.obj_check_stop for the objective gradient, with default values being 1  and n respectively. For the constraint gradient the range is specified by options.con_check_start and options.con_check_stop, with default values being 1  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_nlp (e04ucc) if optional argument options.print_derivNag_D_NoPrint.
Constraint: options.verify_grad=Nag_NoCheck, Nag_SimpleCheck, Nag_CheckObj, Nag_CheckCon, Nag_CheckObjCon, Nag_XSimpleCheck, Nag_XCheckObj, Nag_XCheckCon or Nag_XCheckObjCon.
print_deriv – Nag_DPrintTypeDefault =Nag_D_Full
On entry: controls whether the results of any derivative checking are printed out (see optional argument options.verify_grad).
If a component derivative check has been carried out, then full details will be printed if options.print_deriv=Nag_D_Full. For a printout summarising the results of a component derivative check set options.print_deriv=Nag_D_Sum. If only a simple derivative check is requested then Nag_D_Sum and Nag_D_Full will give the same level of output. To prevent any printout from a derivative check set options.print_deriv=Nag_D_NoPrint.
Constraint: options.print_deriv=Nag_D_NoPrint, Nag_D_Sum or Nag_D_Full.
obj_check_start – IntegerDefault =1
obj_check_stop – IntegerDefault =n
These options take effect only when options.verify_grad=Nag_CheckObj, Nag_CheckObjCon, Nag_XCheckObj or Nag_XCheckObjCon.
On entry: they may be used to control the verification of gradient elements computed by the function objfun. For example, if the first 30 elements appeared to be correct in an earlier run, so that only element 31 remains questionable, it is reasonable to specify options.obj_check_start=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.
Constraint: 1 options.obj_check_start options.obj_check_stop n .
con_check_start – IntegerDefault =1
con_check_stop – IntegerDefault =n
These options take effect only when options.verify_grad=Nag_CheckCon, Nag_CheckObjCon, Nag_XCheckCon or Nag_XCheckObjCon.
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 options.con_check_start=31 .
Constraint: 1 options.con_check_start options.con_check_stop n .
f_diff_int – doubleDefault =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 options.verify_grad).
(b) For estimating unspecified elements of the objective and/or constraint Jacobian matrix.
In general, using the notation r=options.f_diff_int , a derivative with respect to the j th 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 you do not specify a difference interval, 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_nlp (e04ucc) determine constant elements in the objective and constraint gradients (see the descriptions of confun and objfun in Section 5).
Constraint: ε options.f_diff_int < 1.0 .
c_diff_int – doubleDefault =computed automatically
On entry: if the algorithm switches to central differences because the forward-difference approximation is not sufficiently accurate the value of options.c_diff_int 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 5.1). The use of finite differences is discussed under the option options.f_diff_int.
Constraint: ε options.c_diff_int < 1.0 .
max_iter – IntegerDefault = max50, 3 n+nclin + 10ncnlin
On entry: the maximum number of major iterations allowed before termination.
Constraint: options.max_iter0 .
minor_max_iter – IntegerDefault = max50, 3 n+nclin+ncnlin
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: options.minor_max_iter0 .
f_prec – doubleDefault =ε0.9
On entry: this argument 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.
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 nag_opt_nlp (e04ucc) will not attempt to distinguish between function values that differ by less than the error inherent in the calculation.
Constraint: ε options.f_prec < 1.0 .
optim_tol – doubleDefault =options.f_prec0.8
On entry: specifies the accuracy to which you wish the final iterate to approximate a solution of the problem. Broadly speaking, options.optim_tol indicates the number of correct figures desired in the objective function at the solution. For example, if options.optim_tol is 10 -6  and nag_opt_nlp (e04ucc) terminates successfully, the final value of F  should have approximately six correct figures.
nag_opt_nlp (e04ucc) 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 10.1). The sequence of iterates is considered to have converged at x  if
α p r 1 + x , (16)
where p  is the search direction and α  the step length from (3), and r  is the value of options.optim_tol. An iterate is considered to satisfy the first-order conditions for a minimum if
ZT g FR r 1 + max 1 + F x , g FR (17)
and
res j ftol ​ for all ​ j , (18)
where ZT FR g FR  is the projected gradient (see Section 10.1), g FR  is the gradient of F x  with respect to the free variables, res j  is the violation of the j th active nonlinear constraint, and ftol  the value of the optional argument options.nonlin_feas_tol.
Constraint: options.f_prec options.optim_tol < 1.0 .
lin_feas_tol – doubleDefault =ε
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 options.lin_feas_tol.
On entry to nag_opt_nlp (e04ucc), 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 options.lin_feas_tol. All subsequent iterates will satisfy the constraints to within the same tolerance (unless options.lin_feas_tol 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 options.lin_feas_tol as 10 -6 .
Constraint: ε options.lin_feas_tol < 1.0 .
nonlin_feas_tol – doubleDefault =ε0.33​ or ​ε
The default is ε 0.33  if options.con_deriv=Nag_FALSE , and ε  otherwise.
On entry: defines the maximum acceptable violations in the nonlinear constraints at a ‘feasible’ point; i.e., a nonlinear constraint is considered satisfied if its violation does not exceed options.nonlin_feas_tol.
The 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 options.nonlin_feas_tol acts as a partial termination criteria for the iterative sequence generated by nag_opt_nlp (e04ucc) (see the discussion of options.optim_tol ).
This tolerance should reflect the precision of the nonlinear constraint functions calculated by confun.
Constraint: ε options.nonlin_feas_tol < 1.0 .
linesearch_tol – doubleDefault =0.9
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 options.linesearch_tol, 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: 0.0 options.linesearch_tol < 1.0 .
step_limit – doubleDefault =2.0
On entry: specifies the maximum change in the variables at the first step of the line search. In some cases, such as F x = ae bx  or F x = ax b , even a moderate change in the elements of x  can lead to floating point overflow. The argument options.step_limit 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 line search is restricted so that
x ~ - x 2 r 1 + x 2 ,
where r  is the value of options.step_limit.
The line search 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. 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, options.step_limit 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 of options.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 options.step_limit is selected, a good starting point may be required. An important application is to the class of nonlinear least squares problems.
Constraint: options.step_limit>0.0 .
crash_tol – doubleDefault =0.01
On entry: options.crash_tol is used during a ‘cold start’ when nag_opt_nlp (e04ucc) selects an initial working set (options.start=Nag_Cold). The initial working set will include (if possible) bounds or general inequality constraints that lie within options.crash_tol of their bounds. In particular, a constraint of the form ajT x l  will be included in the initial working set if ajT x-l options.crash_tol × 1 + l .
Constraint: 0.0 options.crash_tol 1.0 .
inf_bound – doubleDefault =1020
On entry: options.inf_bound defines the ‘infinite’ bound in the definition of the problem constraints. Any upper bound greater than or equal to options.inf_bound will be regarded as + (and similarly any lower bound less than or equal to -options.inf_bound  will be regarded as -).
Constraint: options.inf_bound>0.0 .
inf_step – doubleDefault = maxoptions.inf_bound,1020
On entry: options.inf_step specifies the magnitude of the change in variables that will be considered a step to an unbounded solution. If the change in x  during an iteration would exceed the value of options.inf_step, the objective function is considered to be unbounded below in the feasible region.
Constraint: options.inf_step>0.0 .
conf – double Default =ncnlin
On entry: ncnlin values of memory will be automatically allocated by nag_opt_nlp (e04ucc) and this is the recommended method of use of conf. However you may supply memory from the calling program.
On exit: if ncnlin>0 , conf[i-1]  contains the value of the i th nonlinear constraint function c i  at the final iterate.
If ncnlin=0  then conf will not be referenced.
conjac – double Default =ncnlin×n
On entry: ncnlin×n values of memory will be automatically allocated by nag_opt_nlp (e04ucc) and this is the recommended method of use of options.conjac. However you may supply memory from the calling program.
On exit: if ncnlin>0 , conjac contains the Jacobian matrix of the nonlinear constraint functions at the final iterate, i.e., conjac[ i-1 × n + j - 1 ]  contains the partial derivative of the i th constraint function with respect to the j th variable, for i=1,2,,ncnlin and j=1,2,,n. (See the discussion of the argument conjac under confun.)
If ncnlin=0  then conjac will not be referenced.
state – Integer Default =n+nclin+ncnlin
On entry: options.state need not be set if the default option of options.start=Nag_Cold is used as n + nclin + ncnlin  values of memory will be automatically allocated by nag_opt_nlp (e04ucc).
If the option options.start=Nag_Warm has been chosen, options.state must point to a minimum of n + nclin + ncnlin  elements of memory. This memory will already be available if the options structure has been used in a previous call to nag_opt_nlp (e04ucc) from the calling program, with options.start=Nag_Cold and the same values of n, nclin and ncnlin. If a previous call has not been made, you must allocate sufficient memory.
When a ‘warm start’ is chosen options.state should specify the status of the bounds and linear constraints at the start of the feasibility phase. More precisely, the first n elements of options.state 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 options.state[j]  are as follows:
options.state[j] 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 bl[j] = bu[j] .
The values -2 , -1  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_nlp (e04ucc) has been called previously with the same values of n, nclin and ncnlin, then options.state already contains satisfactory information. (See also the description of the optional argument options.start.) The function also adjusts (if necessary) the values supplied in x to be consistent with the values supplied in options.state.
Constraint: -2 options.state[j-1] 4 , for j=1,2,, n + nclin + ncnlin .
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 options.state[j]  is as follows:
options.state[j] Meaning
-2 The constraint violates its lower bound by more than the appropriate feasibility tolerance (see the options options.lin_feas_tol and options.nonlin_feas_tol). This value can occur only when no feasible point can be found for a QP subproblem.
-1 The constraint violates its upper bound by more than the appropriate feasibility tolerance (see the options options.lin_feas_tol and options.nonlin_feas_tol). 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 working set as an equality. This value of options.state can occur only when bl[j] = bu[j] .
lambda – double Default =n+nclin+ncnlin
On entry: options.lambda need not be set if the default option of options.start=Nag_Cold is used as n + nclin + ncnlin  values of memory will be automatically allocated by nag_opt_nlp (e04ucc).
If the option options.start=Nag_Warm has been chosen, options.lambda must point to a minimum of n + nclin + ncnlin  elements of memory. This memory will already be available if the options structure has been used in a previous call to nag_opt_nlp (e04ucc) from the calling program, with options.start=Nag_Cold and the same values of n, nclin and ncnlin. If a previous call has not been made, you must allocate sufficient memory.
When a ‘warm start’ is chosen options.lambda[j-1]  must contain a multiplier estimate for each nonlinear constraint with a sign that matches the status of the constraint specified by options.state, for j = n + nclin + 1 , n + nclin + 2 , , n + nclin + ncnlin . The remaining elements need not be set.
Note that if the j th constraint is defined as ‘inactive’ by the initial value of the options.state array (i.e., options.state[j-1] = 0 ), options.lambda[j-1]  should be zero; if the j th constraint is an inequality active at its lower bound (i.e., options.state[j-1] = 1 ), options.lambda[j-1]  should be non-negative; if the j th constraint is an inequality active at its upper bound (i.e., options.state[j-1] = 2 ), options.lambda[j-1]  should be non-positive. If necessary, the function will modify options.lambda to match these rules.
On exit: the values of the Lagrange multipliers from the last QP subproblem. options.lambda[j-1]  should be non-negative if options.state[j-1] = 1  and non-positive if options.state[j-1] = 2 .
h – double Default =n×n
On entry: options.h need not be set if the default option of options.start=Nag_Cold is used, as n×n values of memory will be automatically allocated by nag_opt_nlp (e04ucc).
If the option options.start=Nag_Warm has been chosen, options.h must point to a minimum of n×n 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_nlp (e04ucc) with options.start=Nag_Cold and the same value of n. If a previous call has not been made you must allocate sufficient memory.
When options.start=Nag_Warm is chosen, the memory pointed to by options.h 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. If a previous call has been made, with options.hessian=Nag_TRUE , then options.h will already have been set correctly.
On exit: if options.hessian=Nag_FALSE , options.h contains the upper triangular Cholesky factor R  of QT H ~ Q , an estimate of the transformed and re-ordered Hessian of the Lagrangian at x  (see (6)).
If options.hessian=Nag_TRUE , options.h contains the upper triangular Cholesky factor R  of H , the approximate (untransformed) Hessian of the Lagrangian, with the variables in the natural order.
hessian – Nag_BooleanDefault =Nag_FALSE
On entry: controls the contents of the optional argument options.h on return from nag_opt_nlp (e04ucc). nag_opt_nlp (e04ucc) works exclusively with the transformed and re-ordered Hessian H Q , and hence extra computation is required to form the Hessian itself. If options.hessian=Nag_FALSE , options.h contains the Cholesky factor of the transformed and re-ordered Hessian. If options.hessian=Nag_TRUE , the Cholesky factor of the approximate Hessian itself is formed and stored in options.h. This information is required by nag_opt_nlp (e04ucc) if the next call to nag_opt_nlp (e04ucc) will be made with optional argument options.start=Nag_Warm.
iter – Integer 
On exit: the number of major iterations which have been performed in nag_opt_nlp (e04ucc).
nf – Integer 
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.

11.3  Description of Printed Output

The level of printed output can be controlled with the structure members options.list, options.print_deriv, options.print_level and options.minor_print_level (see Section 11.2). If options.list=Nag_TRUE  then the argument values to nag_opt_nlp (e04ucc) are listed, followed by the result of any derivative check if options.print_deriv=Nag_D_Sum or Nag_D_Full. The printout of results is governed by the values of options.print_level and options.minor_print_level. The default of options.print_level=Nag_Soln_Iter and options.minor_print_level=Nag_NoPrint 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_nlp (e04ucc).
If a simple derivative check, options.verify_grad=Nag_SimpleCheck, is requested then a statement indicating success or failure is given. The largest error found in the constraint Jacobian is output together with the directional derivative, gT p , of the objective gradient and its finite difference approximation, where p  is a random vector of unit length.
When a component derivative check (see options.verify_grad in Section 11.2) is selected the element with the largest relative error is identified for the objective gradient and the constraint Jacobian.
If the value of options.print_deriv=Nag_D_Full then the following results are printed for each component:
x[i]the element of x .
dx[i]the optimal finite difference interval.
g[i] or Jacobian valuethe gradient/Jacobian element.
Difference approxn. the finite difference approximation.
Itnsthe number of trials performed to find a suitable difference interval.
The indicator, OK or BAD? , states whether the gradient/Jacobian element and finite difference approximation are in agreement. If the derivatives are believed to be in error nag_opt_nlp (e04ucc) will exit with fail.code=NE_DERIV_ERRORS.
When options.print_level=Nag_Iter or Nag_Soln_Iter the following line of output is produced at every 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 10).
Note that Mnr may be greater than the optional argument options.minor_max_iter (default value = max50, 3 n + n L + n N ; see Section 11.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 (12) at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty arguments (see Section 10.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_nlp (e04ucc) terminates with fail.code=NW_NONLIN_NOT_FEASIBLE  (no feasible point could be found for the nonlinear constraints).
If no nonlinear constraints are present (i.e., ncnlin=0 ), 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.
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 ZT g FR , the Euclidean norm of the projected gradient (see Section 10.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 H Z    H Z = ZT H FR Z = RZT R Z ; 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 10.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 x  is close to a Kuhn–Tucker point (see Section 10.1).
L is printed if the line search has produced a relative change in x  greater than the value defined by the optional argument options.step_limit (default value =2.0 ; see Section 11.2). If this output occurs frequently during later iterations of the run, options.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, the approximate Hessian is refactorized using column interchanges. If necessary, R  is modified so that its diagonal condition estimator is bounded.
If options.print_level=Nag_Iter_Long, Nag_Soln_Iter_Long, Nag_Soln_Iter_Const or Nag_Soln_Iter_Full 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 Z  (see Section 10.1). 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 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 g FR , 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 H .
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 options.optim_tol in Section 11.2. Each letter is T if the test is satisfied, and F otherwise. The three tests indicate whether:
(i) the sequence of iterates has converged;
(ii) the projected gradient (Norm Gz) is sufficiently small; and
(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 nag_opt_nlp (e04ucc) terminates with the error indicator fail.code=NE_NOERROR , you should check the solution carefully.
When options.print_level=Nag_Soln_Iter_Const or Nag_Soln_Iter_Full more detailed results are given at each iteration. If options.print_level=Nag_Soln_Iter_Const these additional values are: the value of x  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 c ); and the values of the linear constraints, (the vector A L x ).
If options.print_level=Nag_Soln_Iter_Full then the diagonal elements of the matrix T  associated with the TQ  factorization (5) of the QP working set and the diagonal elements of R , the triangular factor of the transformed and re-ordered Hessian (6) (see Section 10.1) are also output at each iteration.
When options.print_level=Nag_Soln, Nag_Soln_Iter, Nag_Soln_Iter_Long, Nag_Soln_Iter_Const or Nag_Soln_Iter_Full the final printout from nag_opt_nlp (e04ucc) 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 j , for j=1,2,,n 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 options.lin_feas_tol and options.nonlin_feas_tol (see Section 11.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 options.lin_feas_tol.
Value is the value of the variable at the final iteration.
Lower bound is the lower bound specified for the variable j . (None indicates that bl[j-1] options.inf_bound, where options.inf_bound is the optional argument.)
Upper bound is the upper bound specified for the variable j . (None indicates that bu[j-1] options.inf_bound, where options.inf_bound 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 bl[j-1] -options.inf_bound  and bu[j-1] options.inf_bound, 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.
Residual 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] -options.inf_bound  and bu[j-1] options.inf_bound).
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,, n L  of the linear constraint.
N Con gives the name (N) and index j-n L , for j = n L + 1 , n L + 2 , , n L + n N  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 options.lin_feas_tol and for nonlinear constraints which violate one of their bounds by more than options.nonlin_feas_tol.
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 options.minor_print_level, you are referred to the documentation for nag_opt_lin_lsq (e04ncc). This option is equivalent to options.print_level.
If options.print_level=Nag_NoPrint then printout will be suppressed; you can print the final solution when nag_opt_nlp (e04ucc) returns to the calling program.

11.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 options.print_fun 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 options.print_fun this will be called in preference to the internal print function of nag_opt_nlp (e04ucc). Calls to the user-defined function are again controlled by means of the options.print_level, options.minor_print_level and options.print_deriv members. Information is provided through st and comm, the two structure arguments to options.print_fun.
If commit_maj_prt = Nag_TRUE then results from the last major iteration of nag_opt_nlp (e04ucc) are provided through st. Note that options.print_fun will be called with commit_maj_prt = Nag_TRUE only if options.print_level=Nag_Iter, Nag_Soln_Iter, Nag_Soln_Iter_Long, Nag_Soln_Iter_Const or Nag_Soln_Iter_Full. The following members of st are set:
nInteger
The number of variables.
nclinInteger
The number of linear constraints.
ncnlinInteger
The number of nonlinear constraints.
nactivInteger
The total number of active elements in the current set.
iterInteger
The major iteration count.
minor_iterInteger
The minor iteration count for the feasibility and the optimality phases of the QP subproblem.
stepdouble
The step taken along the computed search direction.
nfunInteger
The cumulative number of objective function evaluations needed for the line search.
meritdouble
The value of the augmented Lagrangian merit function at the current iterate.
objfdouble
The current value of the objective function.
norm_nlnvioldouble
The Euclidean norm of nonlinear constraint violations (only available if stncnlin > 0 ).
violtndouble
The Euclidean norm of the residuals of constraints that are violated or in the predicted active set (only available if stncnlin > 0 ).
norm_gzdouble
ZT g FR , the Euclidean norm of the projected gradient.
nzInteger
The number of columns of Z  (see Section 10.1).
bndInteger
The number of simple bound constraints in the predicted active set.
linInteger
The number of general linear constraints in the predicted active set.
nlnInteger
The number of nonlinear constraints in the predicted active set (only available if stncnlin > 0 ).
penaltydouble
The Euclidean norm of the vector of penalty arguments used in the augmented Lagrangian merit function (only available if stncnlin > 0 ).
norm_gfdouble
The Euclidean norm of g FR , the gradient of the objective function with respect to the free variables.
cond_hdouble
A lower bound on the condition number of the Hessian approximation H .
cond_hzdouble
A lower bound on the condition number of the projected Hessian approximation H Z .
cond_tdouble
A lower bound on the condition number of the matrix of predicted active constraints.
iter_convNag_Boolean
Nag_TRUE if the sequence of iterates has converged, i.e., convergence condition (16) (see the description of options.optim_tol) is satisfied.
norm_gz_smallNag_Boolean
Nag_TRUE if the projected gradient is sufficiently small, i.e., convergence condition (17) (see the description of options.optim_tol) is satisfied.
violtn_smallNag_Boolean
Nag_TRUE if the violations of the nonlinear constraints are sufficiently small, i.e., convergence condition (18) (see the description of options.optim_tol) is satisfied.
update_modifiedNag_Boolean
Nag_TRUE if the quasi-Newton update was modified to ensure that the Hessian is positive definite.
qp_not_feasibleNag_Boolean
Nag_TRUE if the QP subproblem has no feasible point.
c_diffNag_Boolean
Nag_TRUE if central differences were used to compute the unspecified objective and constraint gradients.
step_limit_exceededNag_Boolean
Nag_TRUE if the line search produced a relative change in x  greater than the value defined by the optional argument options.step_limit.
refactorNag_Boolean
Nag_TRUE if the approximate Hessian has been refactorized.
xdouble *
Contains the components x[j-1]  of the current point x , for j=1,2,,stn.
stateInteger *
Contains the status of the stn variables, stnclin  linear, and stncnlin  nonlinear constraints (if any). See Section 11.2 for a description of the possible status values.
axdouble *
If stnclin > 0 , stax[j-1]  contains the current value of the j th linear constraint, for j=1,2,,stnclin.
cxdouble *
If stncnlin > 0 , stcx[j-1]  contains the current value of nonlinear constraint c j , for j=1,2,,stncnlin.
diagtdouble *
If stnactiv > 0 , the stnactiv  elements of the diagonal of the matrix T .
diagrdouble *
Contains the stn  elements of the diagonal of the upper triangular matrix R .
If commsol_sqp_prt = Nag_TRUE then the final result from nag_opt_nlp (e04ucc) is provided through st. Note that options.print_fun will be called with commsol_sqp_prt = Nag_TRUE only if options.print_level=Nag_Soln, Nag_Soln_Iter, Nag_Soln_Iter_Long, Nag_Soln_Iter_Const or Nag_Soln_Iter_Full. The following members of st are set:
iterInteger
The number of iterations performed.
nInteger
The number of variables.
nclinInteger
The number of linear constraints.
ncnlinInteger
The number of nonlinear constraints.
xdouble *
Contains the components x[j-1]  of the final point x , for j=1,2,,stn.
stateInteger *
Contains the status of the stn  variables, stnclin  linear, and stncnlin  nonlinear constraints (if any). See Section 11.2 for a description of the possible status values.
axdouble *
If stnclin > 0 , stax[j-1]  contains the final value of the j th linear constraint, for j=1,2,,stnclin.
cxdouble *
If stncnlin > 0 , stcx[j-1]  contains the final value of nonlinear constraint c j , for j=1,2,,stncnlin.
bldouble *
Contains the stn + stnclin + stncnlin  lower bounds on the variables.
budouble *
Contains the stn + stnclin + stncnlin  upper bounds on the variables.
lambdadouble *
Contains the stn + stnclin + stncnlin  final values of the Lagrange multipliers.
If commg_prt = Nag_TRUE then the results from derivative checking are provided through st. Note that options.print_fun will be called with commg_prt only if options.print_deriv=Nag_D_Sum or Nag_D_Full. The following members of st are set:
nInteger
The number of variables.
ncnlinInteger
The number of nonlinear constraints.
xdouble *
Contains the components x[j-1]  of the initial point x 0 , for j=1,2,,stn.
gdouble *
Contains the components g[j-1]  of the gradient vector g x = F x1 , F x2 ,, F xn T  at the initial point x 0 , for j=1,2,,stn.
conjacdouble *
Contains the elements of the Jacobian matrix of nonlinear constraints at the initial point x 0  ( fi xj  is held at location conjac[ i-1 × stn + j - 1 ] , for i=1,2,,stncnlin and j=1,2,,stn).
In this case details of the derivative check performed by nag_opt_nlp (e04ucc) are held in the following substructure of st:
gprintNag_GPrintSt *
Which in turn contains three substructures stg_chk, stf_sim, stc_sim and two pointers to arrays of substructures, stf_comp and stc_comp.
g_chkNag_Grad_Chk_St *
The substructure stg_chk contains the members:
typeNag_GradChk
The type of derivative check performed by nag_opt_nlp (e04ucc). This will be the same value as in options.verify_grad.
g_errorInteger
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_startInteger
Specifies the gradient element at which any component check started. This value will be equal to options.obj_check_start.
obj_stopInteger
Specifies the gradient element at which any component check ended. This value specifies the element at which any component check of the constraint gradient ended. This value will be equal to options.obj_check_stop.
con_startInteger
Specifies the element at which any component check of the constraint gradient started. This value will be equal to options.con_check_start.
con_stopInteger
Specifies the element at which any component check of the constraint gradient ended. This value will be equal to options.con_check_stop.
f_simNag_SimSt *
The result of a simple derivative check of the objective gradient, stgprintg_chk.type = Nag_SimpleCheck, will be held in this substructure in members:
correctNag_Boolean
If Nag_TRUE then the objective gradient is consistent with the finite difference approximation according to a simple check.
dir_derivdouble
The directional derivative gT p  where p  is a random vector of unit length with elements of approximately equal magnitude.
fd_approxdouble
The finite difference approximation, F x + hp - F x / h , to the directional derivative.
c_simNag_SimSt *
The result of a simple derivative check of the constraint Jacobian, stgprintg_chk.type = Nag_SimpleCheck, will be held in this substructure in members:
n_elementsInteger
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.
correctNag_Boolean
If Nag_TRUE then the Jacobian is consistent with the finite difference approximation according to a simple check.
max_errordouble
The maximum error found between the norm of a constraint gradient and its finite difference approximation.
max_constraintInteger
The constraint gradient which has the maximum error between its norm and its finite difference approximation.
f_compNag_CompSt *
The results of a requested component derivative check of the objective gradient, stgprintg_chk.type = Nag_CheckObj​ or ​Nag_CheckObjCon, will be held in the array of stn  substructures of type Nag_CompSt pointed to by stgprintf_comp. 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).)
correctNag_Boolean
If Nag_TRUE then this gradient element is consistent with its finite difference approximation.
hoptdouble
The optimal finite difference interval.
gdiffdouble
The finite difference approximation for this gradient component.
iterInteger
The number of trials performed to find a suitable difference interval.
commentchar
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_compNag_CompSt *
The results of a requested component derivative check of the Jacobian of nonlinear constraint functions, stgprintg_chk.type = Nag_CheckCon​ or ​Nag_CheckObjCon, will be held in the array of stncnlin × stn  substructures of type Nag_CompSt pointed to by stgprintc_comp. The element stgprintf_comp[ i-1 × stn + j - 1 ]  will hold the details of the component derivative check for Jacobian element i,j , for i=1,2,,stncnlin and j=1,2,,stn. 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 stgprintc_comp are as for stgprintf_comp where stgprintf_comp.gdiff gives the difference approximation for the Jacobian element.
The relevant members of the structure comm are:
g_prtNag_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_prtNag_Boolean
Will be Nag_TRUE when the print function is called with information about the current major iteration.
sol_sqp_prtNag_Boolean
Will be Nag_TRUE when the print function is called with the details of the final solution.
it_prtNag_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_lmNag_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_prtNag_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.
userdouble
iuserInteger
pPointer 
Pointers for communication of user information. If used they must be allocated memory either before entry to nag_opt_nlp (e04ucc) or during a call to objfun, confun or options.print_fun. The type Pointer will be void * with a C compiler that defines void * and char * otherwise.

nag_opt_nlp (e04ucc) (PDF version)
e04 Chapter Contents
e04 Chapter Introduction
NAG C Library Manual

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