NAG FL Interfacee04usf  (lsq_gencon_deriv_old)e04usa (lsq_gencon_deriv)

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

▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

1Purpose

e04usf/​e04usa is designed to minimize an arbitrary smooth sum of squares function subject to constraints (which may include simple bounds on the variables, linear constraints and smooth nonlinear constraints) using a Sequential Quadratic Programming (SQP) method. As many first derivatives as possible should be supplied by you; any unspecified derivatives are approximated by finite differences. See the description of the optional parameter Derivative Level, in Section 12.1. It is not intended for large sparse problems.
e04usf/​e04usa may also be used for unconstrained, bound-constrained and linearly constrained optimization.
e04usa is a version of e04usf that has additional arguments in order to make it safe for use in multithreaded applications (see Section 5). The initialization routine e04wbf must have been called before calling e04usa.

2Specification

2.1Specification for e04usf

Fortran Interface
 Subroutine e04usf ( m, n, lda, ldcj, ldfj, ldr, a, bl, bu, y, iter, c, cjac, f, fjac, objf, r, x, work,
 Integer, Intent (In) :: m, n, nclin, ncnln, lda, ldcj, ldfj, ldr, liwork, lwork Integer, Intent (Inout) :: istate(n+nclin+ncnln), iuser(*), ifail Integer, Intent (Out) :: iter, iwork(liwork) Real (Kind=nag_wp), Intent (In) :: a(lda,*), bl(n+nclin+ncnln), bu(n+nclin+ncnln), y(m) Real (Kind=nag_wp), Intent (Inout) :: cjac(ldcj,*), fjac(ldfj,n), clamda(n+nclin+ncnln), r(ldr,n), x(n), ruser(*) Real (Kind=nag_wp), Intent (Out) :: c(max(1,ncnln)), f(m), objf, work(lwork) External :: confun, objfun
#include <nag.h>
 void e04usf_ (const Integer *m, const Integer *n, const Integer *nclin, const Integer *ncnln, const Integer *lda, const Integer *ldcj, const Integer *ldfj, const Integer *ldr, const double a[], const double bl[], const double bu[], const double y[], void (NAG_CALL *confun)(Integer *mode, const Integer *ncnln, const Integer *n, const Integer *ldcj, const Integer needc[], const double x[], double c[], double cjac[], const Integer *nstate, Integer iuser[], double ruser[]),void (NAG_CALL *objfun)(Integer *mode, const Integer *m, const Integer *n, const Integer *ldfj, const Integer *needfi, const double x[], double f[], double fjac[], const Integer *nstate, Integer iuser[], double ruser[]),Integer *iter, Integer istate[], double c[], double cjac[], double f[], double fjac[], double clamda[], double *objf, double r[], double x[], Integer iwork[], const Integer *liwork, double work[], const Integer *lwork, Integer iuser[], double ruser[], Integer *ifail)

2.2Specification for e04usa

Fortran Interface
 Subroutine e04usa ( m, n, lda, ldcj, ldfj, ldr, a, bl, bu, y, iter, c, cjac, f, fjac, objf, r, x, work,
 Integer, Intent (In) :: m, n, nclin, ncnln, lda, ldcj, ldfj, ldr, liwork, lwork Integer, Intent (Inout) :: istate(n+nclin+ncnln), iuser(*), iwsav(610), ifail Integer, Intent (Out) :: iter, iwork(liwork) Real (Kind=nag_wp), Intent (In) :: a(lda,*), bl(n+nclin+ncnln), bu(n+nclin+ncnln), y(m) Real (Kind=nag_wp), Intent (Inout) :: cjac(ldcj,*), fjac(ldfj,n), clamda(n+nclin+ncnln), r(ldr,n), x(n), ruser(*), rwsav(475) Real (Kind=nag_wp), Intent (Out) :: c(max(1,ncnln)), f(m), objf, work(lwork) Logical, Intent (Inout) :: lwsav(120) External :: confun, objfun
#include <nag.h>
 void e04usa_ (const Integer *m, const Integer *n, const Integer *nclin, const Integer *ncnln, const Integer *lda, const Integer *ldcj, const Integer *ldfj, const Integer *ldr, const double a[], const double bl[], const double bu[], const double y[], void (NAG_CALL *confun)(Integer *mode, const Integer *ncnln, const Integer *n, const Integer *ldcj, const Integer needc[], const double x[], double c[], double cjac[], const Integer *nstate, Integer iuser[], double ruser[]),void (NAG_CALL *objfun)(Integer *mode, const Integer *m, const Integer *n, const Integer *ldfj, const Integer *needfi, const double x[], double f[], double fjac[], const Integer *nstate, Integer iuser[], double ruser[]),Integer *iter, Integer istate[], double c[], double cjac[], double f[], double fjac[], double clamda[], double *objf, double r[], double x[], Integer iwork[], const Integer *liwork, double work[], const Integer *lwork, Integer iuser[], double ruser[], logical lwsav[], Integer iwsav[], double rwsav[], Integer *ifail)
Before calling e04usa, or either of the option setting routines e04uqa or e04ura, e04wbf must be called. The specification for e04wbf is:
Fortran Interface
 Subroutine e04wbf (
 Integer, Intent (In) :: lcwsav, llwsav, liwsav, lrwsav Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: iwsav(liwsav) Real (Kind=nag_wp), Intent (Out) :: rwsav(lrwsav) Logical, Intent (Out) :: lwsav(llwsav) Character (*), Intent (In) :: rname Character (80), Intent (Out) :: cwsav(lcwsav)
#include <nag.h>
 void e04wbf_ (const char *rname, char cwsav[], const Integer *lcwsav, logical lwsav[], const Integer *llwsav, Integer iwsav[], const Integer *liwsav, double rwsav[], const Integer *lrwsav, Integer *ifail, const Charlen length_rname, const Charlen length_cwsav)
e04wbf should be called with ${\mathbf{rname}}=\text{'e04usa'}$. lcwsav, llwsav, liwsav and lrwsav, the declared lengths of cwsav, lwsav, iwsav and rwsav respectively, must satisfy:
• ${\mathbf{lcwsav}}\ge 1$
• ${\mathbf{llwsav}}\ge 120$
• ${\mathbf{liwsav}}\ge 610$
• ${\mathbf{lrwsav}}\ge 475$
The contents of the arrays cwsav, lwsav, iwsav and rwsav must not be altered between calling routines e04uqa, e04ura, e04usa and e04wbf.

3Description

e04usf/​e04usa is designed to solve the nonlinear least squares programming problem – the minimization of a smooth nonlinear sum of squares function subject to a set of constraints on the variables. The problem is assumed to be stated in the following form:
 $minimize x∈Rn F(x) = 12 ∑ i=1 m (yi-fi(x)) 2 subject to l≤ { x ALx c(x) } ≤u,$ (1)
where $F\left(x\right)$ (the objective function) is a nonlinear function which can be represented as the sum of squares of $m$ subfunctions $\left({y}_{1}-{f}_{1}\left(x\right)\right),\left({y}_{2}-{f}_{2}\left(x\right)\right),\dots ,\left({y}_{m}-{f}_{m}\left(x\right)\right)$, the ${y}_{i}$ are constant, ${A}_{L}$ is an ${n}_{L}×n$ constant matrix, and $c\left(x\right)$ is an ${n}_{N}$ element vector of nonlinear constraint functions. (The matrix ${A}_{L}$ and the vector $c\left(x\right)$ 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 e04usf/​e04usa will usually solve (1) if any isolated discontinuities are 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 $-\infty$ or $+\infty$. (See the description of the optional parameter Infinite Bound Size.)
You must supply an initial estimate of the solution to (1), together with subroutines that define $f\left(x\right)={\left({f}_{1}\left(x\right),{f}_{2}\left(x\right),\dots ,{f}_{m}\left(x\right)\right)}^{\mathrm{T}}$, $c\left(x\right)$ and as many first partial derivatives as possible; unspecified derivatives are approximated by finite differences.
The subfunctions are defined by the array y and objfun, and the nonlinear constraints are defined by confun. On every call, these subroutines must return appropriate values of $f\left(x\right)$ and $c\left(x\right)$. You should also provide the available partial derivatives. Any unspecified derivatives are approximated by finite differences for a discussion of the optional parameter Derivative Level. Note that if there are any nonlinear constraints, then the first call to confun will precede the first call to objfun.
For maximum reliability, it is preferable for you to provide all partial derivatives (see Chapter 8 of Gill et al. (1981) for a detailed discussion). If all gradients cannot be provided, it is similarly advisable to provide as many as possible. While developing objfun and confun, the optional parameter Verify should be used to check the calculation of any known gradients.

4References

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

5Arguments

1: $\mathbf{m}$Integer Input
On entry: $m$, the number of subfunctions associated with $F\left(x\right)$.
Constraint: ${\mathbf{m}}>0$.
2: $\mathbf{n}$Integer Input
On entry: $n$, the number of variables.
Constraint: ${\mathbf{n}}>0$.
3: $\mathbf{nclin}$Integer Input
On entry: ${n}_{L}$, the number of general linear constraints.
Constraint: ${\mathbf{nclin}}\ge 0$.
4: $\mathbf{ncnln}$Integer Input
On entry: ${n}_{N}$, the number of nonlinear constraints.
Constraint: ${\mathbf{ncnln}}\ge 0$.
5: $\mathbf{lda}$Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which e04usf/​e04usa is called.
Constraint: ${\mathbf{lda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nclin}}\right)$.
6: $\mathbf{ldcj}$Integer Input
On entry: the first dimension of the array cjac as declared in the (sub)program from which e04usf/​e04usa is called.
Constraint: ${\mathbf{ldcj}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{ncnln}}\right)$.
7: $\mathbf{ldfj}$Integer Input
On entry: the first dimension of the array fjac as declared in the (sub)program from which e04usf/​e04usa is called.
Constraint: ${\mathbf{ldfj}}\ge {\mathbf{m}}$.
8: $\mathbf{ldr}$Integer Input
On entry: the first dimension of the array r as declared in the (sub)program from which e04usf/​e04usa is called.
Constraint: ${\mathbf{ldr}}\ge {\mathbf{n}}$.
9: $\mathbf{a}\left({\mathbf{lda}},*\right)$Real (Kind=nag_wp) array Input
Note: the second dimension of the array a must be at least ${\mathbf{n}}$ if ${\mathbf{nclin}}>0$, and at least $1$ otherwise.
On entry: the $\mathit{i}$th row of a contains the $\mathit{i}$th row of the matrix ${A}_{L}$ of general linear constraints in (1). That is, the $\mathit{i}$th row contains the coefficients of the $\mathit{i}$th general linear constraint, for $\mathit{i}=1,2,\dots ,{\mathbf{nclin}}$.
If ${\mathbf{nclin}}=0$, the array a is not referenced.
10: $\mathbf{bl}\left({\mathbf{n}}+{\mathbf{nclin}}+{\mathbf{ncnln}}\right)$Real (Kind=nag_wp) array Input
11: $\mathbf{bu}\left({\mathbf{n}}+{\mathbf{nclin}}+{\mathbf{ncnln}}\right)$Real (Kind=nag_wp) array Input
On entry: 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 general nonlinear constraints (if any). To specify a nonexistent lower bound (i.e., ${l}_{j}=-\infty$), set ${\mathbf{bl}}\left(j\right)\le -\mathit{bigbnd}$, and to specify a nonexistent upper bound (i.e., ${u}_{j}=+\infty$), set ${\mathbf{bu}}\left(j\right)\ge \mathit{bigbnd}$; the default value of $\mathit{bigbnd}$ is ${10}^{20}$, but this may be changed by the optional parameter Infinite Bound Size. To specify the $j$th constraint as an equality, set ${\mathbf{bl}}\left(j\right)={\mathbf{bu}}\left(j\right)=\beta$, say, where $|\beta |<\mathit{bigbnd}$.
Constraints:
• ${\mathbf{bl}}\left(\mathit{j}\right)\le {\mathbf{bu}}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,{\mathbf{n}}+{\mathbf{nclin}}+{\mathbf{ncnln}}$;
• if ${\mathbf{bl}}\left(j\right)={\mathbf{bu}}\left(j\right)=\beta$, $|\beta |<\mathit{bigbnd}$.
12: $\mathbf{y}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Input
On entry: the coefficients of the constant vector $y$ of the objective function.
13: $\mathbf{confun}$Subroutine, supplied by the NAG Library or the user. External Procedure
confun must calculate the vector $c\left(x\right)$ of nonlinear constraint functions and (optionally) its Jacobian ($\text{}=\frac{\partial c}{\partial x}$) for a specified $n$-element vector $x$. If there are no nonlinear constraints (i.e., ${\mathbf{ncnln}}=0$), confun will never be called by e04usf/​e04usa and confun may be the dummy routine e04udm. (e04udm is included in the NAG Library.) If there are nonlinear constraints, the first call to confun will occur before the first call to objfun.
The specification of confun is:
Fortran Interface
 Subroutine confun ( mode, n, ldcj, x, c, cjac,
 Integer, Intent (In) :: ncnln, n, ldcj, needc(ncnln), nstate Integer, Intent (Inout) :: mode, iuser(*) Real (Kind=nag_wp), Intent (In) :: x(n) Real (Kind=nag_wp), Intent (Inout) :: cjac(ldcj,n), ruser(*) Real (Kind=nag_wp), Intent (Out) :: c(ncnln)
 void confun (Integer *mode, const Integer *ncnln, const Integer *n, const Integer *ldcj, const Integer needc[], const double x[], double c[], double cjac[], const Integer *nstate, Integer iuser[], double ruser[])
1: $\mathbf{mode}$Integer Input/Output
On entry: indicates which values must be assigned during each call of confun. Only the following values need be assigned, for each value of $i$ such that ${\mathbf{needc}}\left(i\right)>0$:
${\mathbf{mode}}=0$
${\mathbf{c}}\left(i\right)$.
${\mathbf{mode}}=1$
All available elements in the $i$th row of cjac.
${\mathbf{mode}}=2$
${\mathbf{c}}\left(i\right)$ and all available elements in the $i$th row of cjac.
On exit: may be set to a negative value if you wish to terminate the solution to the current problem, and in this case e04usf/​e04usa will terminate with ifail set to mode.
2: $\mathbf{ncnln}$Integer Input
On entry: ${n}_{N}$, the number of nonlinear constraints.
3: $\mathbf{n}$Integer Input
On entry: $n$, the number of variables.
4: $\mathbf{ldcj}$Integer Input
On entry: the first dimension of the array cjac as declared in the (sub)program from which e04usf/​e04usa is called.
5: $\mathbf{needc}\left({\mathbf{ncnln}}\right)$Integer array Input
On entry: the indices of the elements of c and/or cjac that must be evaluated by confun. If ${\mathbf{needc}}\left(i\right)>0$, the $i$th element of c and/or the available elements of the $i$th row of cjac (see argument mode) must be evaluated at $x$.
6: $\mathbf{x}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: $x$, the vector of variables at which the constraint functions and/or all available elements of the constraint Jacobian are to be evaluated.
7: $\mathbf{c}\left({\mathbf{ncnln}}\right)$Real (Kind=nag_wp) array Output
On exit: if ${\mathbf{needc}}\left(i\right)>0$ and ${\mathbf{mode}}=0$ or $2$, ${\mathbf{c}}\left(i\right)$ must contain the value of the $i$th constraint at $x$. The remaining elements of c, corresponding to the non-positive elements of needc, are ignored.
8: $\mathbf{cjac}\left({\mathbf{ldcj}},{\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: is set to a special value.
On exit: if ${\mathbf{needc}}\left(i\right)>0$ and ${\mathbf{mode}}=1$ or $2$, the $i$th row of cjac must contain the available elements of the vector $\nabla {c}_{i}$ given by
 $∇ci= ( ∂ci ∂x1 , ∂ci ∂x2 ,…, ∂ci ∂xn ) T,$
where $\frac{\partial {c}_{i}}{\partial {x}_{j}}$ is the partial derivative of the $i$th constraint with respect to the $j$th variable, evaluated at the point $x$. See also the argument nstate. The remaining rows of cjac, corresponding to non-positive elements of needc, are ignored.
If all elements of the constraint Jacobian are known (i.e., ${\mathbf{Derivative Level}}=2$ or $3$), any constant elements may be assigned to cjac one time only at the start of the optimization. An element of cjac that is not subsequently assigned in confun will retain its initial value throughout. Constant elements may be loaded into cjac either before the call to e04usf/​e04usa or during the first call to confun (signalled by the value ${\mathbf{nstate}}=1$). The ability to preload constants is useful when many Jacobian elements are identically zero, in which case cjac may be initialized to zero and nonzero elements may be reset by confun.
Note that constant nonzero elements do affect the values of the constraints. Thus, if ${\mathbf{cjac}}\left(i,j\right)$ is set to a constant value, it need not be reset in subsequent calls to confun, but the value ${\mathbf{cjac}}\left(i,j\right)×{\mathbf{x}}\left(j\right)$ must nonetheless be added to ${\mathbf{c}}\left(i\right)$. For example, if ${\mathbf{cjac}}\left(1,1\right)=2$ and ${\mathbf{cjac}}\left(1,2\right)=-5$, the term $2×{\mathbf{x}}\left(1\right)-5×{\mathbf{x}}\left(2\right)$ must be included in the definition of ${\mathbf{c}}\left(1\right)$.
It must be emphasized that, if ${\mathbf{Derivative Level}}=0$ or $1$, unassigned elements of cjac are not treated as constant; they are estimated by finite differences, at nontrivial expense. If you do not supply a value for the optional parameter Difference Interval, an interval for each element of $x$ is computed automatically at the start of the optimization. The automatic procedure can usually identify constant elements of cjac, which are then computed once only by finite differences.
9: $\mathbf{nstate}$Integer Input
On entry: if ${\mathbf{nstate}}=1$, then e04usf/​e04usa is calling confun for the first time. This argument setting allows you to save computation time if certain data must be read or calculated only once.
10: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
11: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
confun is called with the arguments iuser and ruser as supplied to e04usf/​e04usa. You should use the arrays iuser and ruser to supply information to confun.
confun must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which e04usf/​e04usa is called. Arguments denoted as Input must not be changed by this procedure.
Note: confun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by e04usf/​e04usa. If your code inadvertently does return any NaNs or infinities, e04usf/​e04usa is likely to produce unexpected results.
confun should be tested separately before being used in conjunction with e04usf/​e04usa. See also the description of the optional parameter Verify.
14: $\mathbf{objfun}$Subroutine, supplied by the user. External Procedure
objfun must calculate either the $i$th element of the vector $f\left(x\right)={\left({f}_{1}\left(x\right),{f}_{2}\left(x\right),\dots ,{f}_{m}\left(x\right)\right)}^{\mathrm{T}}$ or all $m$ elements of $f\left(x\right)$ and (optionally) its Jacobian ($\text{}=\frac{\partial f}{\partial x}$) for a specified $n$-element vector $x$.
The specification of objfun is:
Fortran Interface
 Subroutine objfun ( mode, m, n, ldfj, x, f, fjac,
 Integer, Intent (In) :: m, n, ldfj, needfi, nstate Integer, Intent (Inout) :: mode, iuser(*) Real (Kind=nag_wp), Intent (In) :: x(n) Real (Kind=nag_wp), Intent (Inout) :: fjac(ldfj,n), ruser(*) Real (Kind=nag_wp), Intent (Out) :: f(m)
 void objfun (Integer *mode, const Integer *m, const Integer *n, const Integer *ldfj, const Integer *needfi, const double x[], double f[], double fjac[], const Integer *nstate, Integer iuser[], double ruser[])
1: $\mathbf{mode}$Integer Input/Output
On entry: indicates which values must be assigned during each call of objfun. Only the following values need be assigned:
${\mathbf{mode}}=0$ and ${\mathbf{needfi}}=i$, where $i>0$
${\mathbf{f}}\left(i\right)$.
${\mathbf{mode}}=0$ and ${\mathbf{needfi}}<0$
f.
${\mathbf{mode}}=1$ and ${\mathbf{needfi}}<0$
All available elements of fjac.
${\mathbf{mode}}=2$ and ${\mathbf{needfi}}<0$
f and all available elements of fjac.
On exit: may be set to a negative value if you wish to terminate the solution to the current problem, and in this case e04usf/​e04usa will terminate with ifail set to mode.
2: $\mathbf{m}$Integer Input
On entry: $m$, the number of subfunctions.
3: $\mathbf{n}$Integer Input
On entry: $n$, the number of variables.
4: $\mathbf{ldfj}$Integer Input
On entry: the first dimension of the array fjac as declared in the (sub)program from which e04usf/​e04usa is called.
5: $\mathbf{needfi}$Integer Input
On entry: if ${\mathbf{needfi}}=i>0$, only the $i$th element of $f\left(x\right)$ needs to be evaluated at $x$; the remaining elements need not be set. This can result in significant computational savings when $m\gg n$.
6: $\mathbf{x}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input
On entry: $x$, the vector of variables at which $f\left(x\right)$ and/or all available elements of its Jacobian are to be evaluated.
7: $\mathbf{f}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Output
On exit: if ${\mathbf{mode}}=0$ and ${\mathbf{needfi}}=i>0$, ${\mathbf{f}}\left(i\right)$ must contain the value of ${f}_{i}$ at $x$.
If ${\mathbf{mode}}=0$ or $2$ and ${\mathbf{needfi}}<0$, ${\mathbf{f}}\left(\mathit{i}\right)$ must contain the value of ${f}_{\mathit{i}}$ at $x$, for $\mathit{i}=1,2,\dots ,m$.
8: $\mathbf{fjac}\left({\mathbf{ldfj}},{\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: is set to a special value.
On exit: if ${\mathbf{mode}}=1$ or $2$ and ${\mathbf{needfi}}<0$, the $i$th row of fjac must contain the available elements of the vector $\nabla {f}_{i}$ given by
 $∇fi= ( ∂fi ∂x1 , ∂fi ∂x2 ,…, ∂fi ∂xn ) T,$
evaluated at the point $x$. See also the argument nstate.
9: $\mathbf{nstate}$Integer Input
On entry: if ${\mathbf{nstate}}=1$, then e04usf/​e04usa is calling objfun for the first time. This argument setting allows you to save computation time if certain data must be read or calculated only once.
10: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
11: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
objfun is called with the arguments iuser and ruser as supplied to e04usf/​e04usa. You should use the arrays iuser and ruser to supply information to objfun.
objfun must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which e04usf/​e04usa is called. Arguments denoted as Input must not be changed by this procedure.
Note: objfun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by e04usf/​e04usa. If your code inadvertently does return any NaNs or infinities, e04usf/​e04usa is likely to produce unexpected results.
objfun should be tested separately before being used in conjunction with e04usf/​e04usa. See also the description of the optional parameter Verify.
15: $\mathbf{iter}$Integer Output
On exit: the number of major iterations performed.
16: $\mathbf{istate}\left({\mathbf{n}}+{\mathbf{nclin}}+{\mathbf{ncnln}}\right)$Integer array Input/Output
On entry: need not be set if the (default) optional parameter Cold Start is used.
If the optional parameter Warm Start has been chosen, the elements of istate corresponding to the bounds and linear constraints define the initial working set for the procedure that finds a feasible point for the linear constraints and bounds. The active set at the conclusion of this procedure and the elements of istate corresponding to nonlinear constraints then define the initial working set for the first QP subproblem. More precisely, the first $n$ elements of istate refer to the upper and lower bounds on the variables, the next ${n}_{L}$ elements refer to the upper and lower bounds on ${A}_{L}x$, and the next ${n}_{N}$ elements refer to the upper and lower bounds on $c\left(x\right)$. Possible values for ${\mathbf{istate}}\left(j\right)$ are as follows:
${\mathbf{istate}}\left(\mathbit{j}\right)$ Meaning
0 The corresponding constraint is not in the initial QP working set.
1 This inequality constraint should be in the working set at its lower bound.
2 This inequality constraint should be in the working set at its upper bound.
3 This equality constraint should be in the initial working set. This value must not be specified unless ${\mathbf{bl}}\left(j\right)={\mathbf{bu}}\left(j\right)$.
The values $-2$, $-1$ and $4$ are also acceptable but will be modified by the routine. If e04usf/​e04usa has been called previously with the same values of n, nclin and ncnln, istate already contains satisfactory information. (See also the description of the optional parameter Warm Start.) The routine also adjusts (if necessary) the values supplied in x to be consistent with istate.
Constraint: $-2\le {\mathbf{istate}}\left(\mathit{j}\right)\le 4$, for $\mathit{j}=1,2,\dots ,{\mathbf{n}}+{\mathbf{nclin}}+{\mathbf{ncnln}}$.
On exit: the status of the constraints in the QP working set at the point returned in x. The significance of each possible value of ${\mathbf{istate}}\left(j\right)$ is as follows:
${\mathbf{istate}}\left(\mathbit{j}\right)$ Meaning
$-2$ This constraint violates its lower bound by more than the appropriate feasibility tolerance (see the optional parameters Linear Feasibility Tolerance and Nonlinear Feasibility Tolerance). This value can occur only when no feasible point can be found for a QP subproblem.
$-1$ This constraint violates its upper bound by more than the appropriate feasibility tolerance (see the optional parameters Linear Feasibility Tolerance and Nonlinear Feasibility Tolerance). This value can occur only when no feasible point can be found for a QP subproblem.
$\phantom{-}0$ The constraint is satisfied to within the feasibility tolerance, but is not in the QP working set.
$\phantom{-}1$ This inequality constraint is included in the QP working set at its lower bound.
$\phantom{-}2$ This inequality constraint is included in the QP working set at its upper bound.
$\phantom{-}3$ This constraint is included in the QP working set as an equality. This value of istate can occur only when ${\mathbf{bl}}\left(j\right)={\mathbf{bu}}\left(j\right)$.
17: $\mathbf{c}\left(\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{ncnln}}\right)\right)$Real (Kind=nag_wp) array Output
On exit: if ${\mathbf{ncnln}}>0$, ${\mathbf{c}}\left(\mathit{i}\right)$ contains the value of the $\mathit{i}$th nonlinear constraint function ${c}_{\mathit{i}}$ at the final iterate, for $\mathit{i}=1,2,\dots ,{\mathbf{ncnln}}$.
If ${\mathbf{ncnln}}=0$, c is not referenced.
18: $\mathbf{cjac}\left({\mathbf{ldcj}},*\right)$Real (Kind=nag_wp) array Input/Output
Note: the second dimension of the array cjac must be at least ${\mathbf{n}}$ if ${\mathbf{ncnln}}>0$, and at least $1$ otherwise.
On entry: in general, cjac need not be initialized before the call to e04usf/​e04usa. However, if ${\mathbf{Derivative Level}}=3$, you may optionally set the constant elements of cjac (see argument nstate in the description of confun). Such constant elements need not be re-assigned on subsequent calls to confun.
On exit: if ${\mathbf{ncnln}}>0$, cjac contains the Jacobian matrix of the nonlinear constraint functions at the final iterate, i.e., ${\mathbf{cjac}}\left(\mathit{i},\mathit{j}\right)$ contains the partial derivative of the $\mathit{i}$th constraint function with respect to the $\mathit{j}$th variable, for $\mathit{i}=1,2,\dots ,{\mathbf{ncnln}}$ and $\mathit{j}=1,2,\dots ,{\mathbf{n}}$. (See the discussion of argument cjac under confun.)
If ${\mathbf{ncnln}}=0$, cjac is not referenced.
19: $\mathbf{f}\left({\mathbf{m}}\right)$Real (Kind=nag_wp) array Output
On exit: ${\mathbf{f}}\left(\mathit{i}\right)$ contains the value of the $\mathit{i}$th function ${f}_{\mathit{i}}$ at the final iterate, for $\mathit{i}=1,2,\dots ,{\mathbf{m}}$.
20: $\mathbf{fjac}\left({\mathbf{ldfj}},{\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: in general, fjac need not be initialized before the call to e04usf/​e04usa. However, if ${\mathbf{Derivative Level}}=3$, you may optionally set the constant elements of fjac (see argument nstate in the description of objfun). Such constant elements need not be re-assigned on subsequent calls to objfun.
On exit: the Jacobian matrix of the functions ${f}_{1},{f}_{2},\dots ,{f}_{m}$ at the final iterate, i.e., ${\mathbf{fjac}}\left(\mathit{i},\mathit{j}\right)$ contains the partial derivative of the $\mathit{i}$th function with respect to the $\mathit{j}$th variable, for $\mathit{i}=1,2,\dots ,{\mathbf{m}}$ and $\mathit{j}=1,2,\dots ,{\mathbf{n}}$. (See also the discussion of argument fjac under objfun.)
21: $\mathbf{clamda}\left({\mathbf{n}}+{\mathbf{nclin}}+{\mathbf{ncnln}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: need not be set if the (default) optional parameter Cold Start is used.
If the optional parameter Warm Start has been chosen, ${\mathbf{clamda}}\left(\mathit{j}\right)$ must contain a multiplier estimate for each nonlinear constraint with a sign that matches the status of the constraint specified by the istate array, for $\mathit{j}={\mathbf{n}}+{\mathbf{nclin}}+1,\dots ,{\mathbf{n}}+{\mathbf{nclin}}+{\mathbf{ncnln}}$. The remaining elements need not be set. Note that if the $j$th constraint is defined as ‘inactive’ by the initial value of the istate array (i.e., ${\mathbf{istate}}\left(j\right)=0$), ${\mathbf{clamda}}\left(j\right)$ should be zero; if the $j$th constraint is an inequality active at its lower bound (i.e., ${\mathbf{istate}}\left(j\right)=1$), ${\mathbf{clamda}}\left(j\right)$ should be non-negative; if the $j$th constraint is an inequality active at its upper bound (i.e., ${\mathbf{istate}}\left(j\right)=2$, ${\mathbf{clamda}}\left(j\right)$ should be non-positive. If necessary, the routine will modify clamda to match these rules.
On exit: the values of the QP multipliers from the last QP subproblem. ${\mathbf{clamda}}\left(j\right)$ should be non-negative if ${\mathbf{istate}}\left(j\right)=1$ and non-positive if ${\mathbf{istate}}\left(j\right)=2$.
22: $\mathbf{objf}$Real (Kind=nag_wp) Output
On exit: the value of the objective function at the final iterate.
23: $\mathbf{r}\left({\mathbf{ldr}},{\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: need not be initialized if the (default) optional parameter Cold Start is used.
If the optional parameter Warm Start has been chosen, r must contain the upper triangular Cholesky factor $R$ of the initial approximation of the Hessian of the Lagrangian function, with the variables in the natural order. Elements not in the upper triangular part of r are assumed to be zero and need not be assigned.
On exit: if ${\mathbf{Hessian}}=\mathrm{NO}$, r contains the upper triangular Cholesky factor $R$ of ${Q}^{\mathrm{T}}\stackrel{~}{H}Q$, an estimate of the transformed and reordered Hessian of the Lagrangian at $x$ (see (6) in e04uff/​e04ufa). If ${\mathbf{Hessian}}=\mathrm{YES}$, r contains the upper triangular Cholesky factor $R$ of $H$, the approximate (untransformed) Hessian of the Lagrangian, with the variables in the natural order.
24: $\mathbf{x}\left({\mathbf{n}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: an initial estimate of the solution.
On exit: the final estimate of the solution.
25: $\mathbf{iwork}\left({\mathbf{liwork}}\right)$Integer array Workspace
26: $\mathbf{liwork}$Integer Input
On entry: the dimension of the array iwork as declared in the (sub)program from which e04usf/​e04usa is called.
Constraint: ${\mathbf{liwork}}\ge 3×{\mathbf{n}}+{\mathbf{nclin}}+2×{\mathbf{ncnln}}$.
27: $\mathbf{work}\left({\mathbf{lwork}}\right)$Real (Kind=nag_wp) array Workspace
28: $\mathbf{lwork}$Integer Input
On entry: the dimension of the array work as declared in the (sub)program from which e04usf/​e04usa is called.
Constraints:
• if ${\mathbf{ncnln}}=0$ and ${\mathbf{nclin}}=0$, ${\mathbf{lwork}}\ge 20×{\mathbf{n}}+{\mathbf{m}}×\left({\mathbf{n}}+3\right)$;
• if ${\mathbf{ncnln}}=0$ and ${\mathbf{nclin}}>0$, ${\mathbf{lwork}}\ge 2×{{\mathbf{n}}}^{2}+20×{\mathbf{n}}+11×{\mathbf{nclin}}+\phantom{\rule{0ex}{0ex}}{\mathbf{m}}×\left({\mathbf{n}}+3\right)$;
• if ${\mathbf{ncnln}}>0$ and ${\mathbf{nclin}}\ge 0$, ${\mathbf{lwork}}\ge 2×{{\mathbf{n}}}^{2}+{\mathbf{n}}×{\mathbf{nclin}}+2×{\mathbf{n}}×\phantom{\rule{0ex}{0ex}}{\mathbf{ncnln}}+20×{\mathbf{n}}+11×{\mathbf{nclin}}+21×{\mathbf{ncnln}}+{\mathbf{m}}×\left({\mathbf{n}}+3\right)$.
The amounts of workspace provided and required are (by default) output on the current advisory message unit (as defined by x04abf). As an alternative to computing liwork and lwork from the formulas given above, you may prefer to obtain appropriate values from the output of a preliminary run with liwork and lwork set to $1$. (e04usf/​e04usa will then terminate with ${\mathbf{ifail}}={\mathbf{9}}$.)
29: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
30: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
iuser and ruser are not used by e04usf/​e04usa, but are passed directly to confun and objfun and may be used to pass information to these routines.
31: $\mathbf{ifail}$Integer Input/Output
Note: for e04usa, ifail does not occur in this position in the argument list. See the additional arguments described below.
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $-1$ is recommended since useful values can be provided in some output arguments even when ${\mathbf{ifail}}\ne {\mathbf{0}}$ on exit. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).
e04usf/​e04usa returns with ${\mathbf{ifail}}={\mathbf{0}}$ if the iterates have converged to a point $x$ that satisfies the first-order Kuhn–Tucker conditions (see Section 11.1 in e04uff/​e04ufa) to the accuracy requested by the optional parameter Optimality Tolerance ($\text{default value}={\epsilon }_{r}^{0.8}$, where ${\epsilon }_{r}$ is the value of the optional parameter Function Precision ($\text{default value}={\epsilon }^{0.9}$, where $\epsilon$ is the machine precision)), i.e., the projected gradient and active constraint residuals are negligible at $x$.
You should check whether the following four conditions are satisfied:
1. (i)the final value of Norm Gz (see Section 9.1) is significantly less than that at the starting point;
2. (ii)during the final major iterations, the values of Step and Mnr (see Section 9.1) are both one;
3. (iii)the last few values of both Norm Gz and Violtn (see Section 9.1) become small at a fast linear rate; and
4. (iv)Cond Hz (see Section 9.1) is small.
If all these conditions hold, $x$ is almost certainly a local minimum of (1).
Note: the following are additional arguments for specific use with e04usa. Users of e04usf therefore need not read the remainder of this description.
31: $\mathbf{lwsav}\left(120\right)$Logical array Communication Array
32: $\mathbf{iwsav}\left(610\right)$Integer array Communication Array
33: $\mathbf{rwsav}\left(475\right)$Real (Kind=nag_wp) array Communication Array
The arrays lwsav, iwsav and rwsav must not be altered between calls to any of the routines e04usa, e04uqa or e04ura.
34: $\mathbf{ifail}$Integer Input/Output
Note: see the argument description for ifail above.

6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
Note: in some cases e04usf/​e04usa may return useful information.
${\mathbf{ifail}}=1$
Optimal solution found, but requested accuracy not achieved.
The final iterate $x$ satisfies the first-order Kuhn–Tucker conditions (see Section 11.1 in e04uff/​e04ufa) to the accuracy requested, but the sequence of iterates has not yet converged. e04usf/​e04usa was terminated because no further improvement could be made in the merit function (see Section 9.1).
This value of ifail 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 parameter Function Precision ($\text{default value}={\epsilon }^{0.9}$, where $\epsilon$ is the machine precision)). 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 5 for ${\mathbf{ifail}}={\mathbf{0}}$ are satisfied, $x$ is likely to be a solution of (1) even if ${\mathbf{ifail}}={\mathbf{1}}$.
${\mathbf{ifail}}=2$
No feasible point for the linear constraints.
e04usf/​e04usa 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 parameter Linear Feasibility Tolerance ($\text{default value}=\sqrt{\epsilon }$, where $\epsilon$ is the machine precision), or no feasible point could be found in the number of iterations specified by the optional parameter Minor Iteration Limit ($\text{default value}=\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(50,3\left(n+{n}_{L}+{n}_{N}\right)\right)$). You should check that there are no constraint redundancies. If the data for the constraints are accurate only to an absolute precision $\sigma$, you should ensure that the value of the optional parameter Linear Feasibility Tolerance is greater than $\sigma$. For example, if all elements of ${A}_{L}$ are of order unity and are accurate to only three decimal places, Linear Feasibility Tolerance should be at least ${10}^{-3}$.
${\mathbf{ifail}}=3$
No feasible point 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 line of intermediate printout produced by the major iterations; see Section 9.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 istate. If you are convinced that a feasible point does exist, e04usf/​e04usa should be restarted at a different starting point.
${\mathbf{ifail}}=4$
Too many major iterations.
If the algorithm appears to be making satisfactory progress, Major Iteration Limit may be too small. If so, either increase its value and rerun e04usf/​e04usa or, alternatively, rerun e04usf/​e04usa using the optional parameter Warm Start. 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 ${\mathbf{ifail}}={\mathbf{6}}$.
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 major iterations (i.e., an R occurs at the end of each line of intermediate printout; see Section 9.1), it may be worthwhile to try a Warm Start at the final point as suggested above.
${\mathbf{ifail}}=6$
Current point cannot be improved upon.
$x$ does not satisfy the first-order Kuhn–Tucker conditions (see Section 11.1 in e04uff/​e04ufa), and no improved point for the merit function (see Section 9.1) could be found during the final linesearch.
This sometimes occurs because an overly stringent accuracy has been requested, i.e., the value of the optional parameter Optimality Tolerance ($\text{default value}={\epsilon }_{r}^{0.8}$, where ${\epsilon }_{r}$ is the value of the optional parameter Function Precision ($\text{default value}={\epsilon }^{0.9}$, where $\epsilon$ is the machine precision)) is too small. In this case you should apply the four tests described under ${\mathbf{ifail}}={\mathbf{0}}$ 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 e04usf/​e04usa has failed completely to move from the initial point then user-supplied subroutines objfun and/or confun may be incorrect. You should refer to comments under ${\mathbf{ifail}}={\mathbf{7}}$ and check the gradients using the optional parameter Verify ($\text{default value}=0$). 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 9.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 9.1).
If the condition estimate of the projected Hessian (Cond Hz; see Section 13) is extremely large, it may be worthwhile rerunning e04usf/​e04usa from the final point with the optional parameter Warm Start. In this situation, istate and clamda should be left unaltered and ${\mathbf{r}}$ 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 13), it may be helpful to run e04usf/​e04usa with a relaxed value of the optional parameter Feasibility Tolerance ($\text{default value}=\sqrt{\epsilon }$, where $\epsilon$ is the machine precision). (Constraint dependencies are often indicated by wide variations in size in the diagonal elements of the matrix $T$, whose diagonals will be printed if ${\mathbf{Major Print Level}}\ge 30$).
${\mathbf{ifail}}=7$
Large errors found in the derivatives.
Large errors were found in the derivatives of the subfunctions and/or nonlinear constraints. This value of ifail will occur if the verification process indicated that at least one 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 subfunction and constraint values is correct – for example, by computing the subfunctions at a point where the correct value of $F\left(x\right)$ is known. However, care should be taken that the chosen point fully tests the evaluation of the subfunctions. 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 before each function evaluation.
Errors in programming the subfunctions may be quite subtle in that the subfunction values are ‘almost’ correct. For example, a subfunction 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 subfunction 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 subfunction; since some compilers do not convert such constants to double precision, half the correct figures may be lost by such a seemingly trivial error.
${\mathbf{ifail}}=9$
Not enough workspace to solve problem. Workspace provided is ${\mathbf{iwork}}\left(⟨\mathit{\text{value}}⟩\right)$ and ${\mathbf{work}}\left(⟨\mathit{\text{value}}⟩\right)$. To solve problem we need ${\mathbf{iwork}}\left(⟨\mathit{\text{value}}⟩\right)$ and ${\mathbf{work}}\left(⟨\mathit{\text{value}}⟩\right)$.
On entry, ${\mathbf{lda}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{nclin}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{lda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nclin}}\right)$.
On entry, ${\mathbf{ldcj}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{ncnln}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldcj}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{ncnln}}\right)$.
On entry, ${\mathbf{ldfj}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldfj}}\ge {\mathbf{m}}$.
On entry, ${\mathbf{ldr}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldr}}\ge {\mathbf{n}}$.
On entry, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{m}}\ge 1$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 1$.
On entry, ${\mathbf{nclin}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{nclin}}\ge 0$.
On entry, ${\mathbf{ncnln}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ncnln}}\ge 0$.
On entry, the bounds on $⟨\mathit{\text{value}}⟩$ are inconsistent: ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
On entry, the bounds on linear constraint $⟨\mathit{\text{value}}⟩$ are inconsistent: ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
On entry, the bounds on nonlinear constraint $⟨\mathit{\text{value}}⟩$ are inconsistent: ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
On entry, the bounds on variable $⟨\mathit{\text{value}}⟩$ are inconsistent: ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
On entry, the equal bounds on $⟨\mathit{\text{value}}⟩$ are infinite, because ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$, but $|\mathrm{beta}|\ge \mathrm{bigbnd}$: $\mathrm{beta}=⟨\mathit{\text{value}}⟩$ and $\mathrm{bigbnd}=⟨\mathit{\text{value}}⟩$.
On entry, the equal bounds on linear constraint $⟨\mathit{\text{value}}⟩$ are infinite, because ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$, but $|\mathrm{beta}|\ge \mathrm{bigbnd}$: $\mathrm{beta}=⟨\mathit{\text{value}}⟩$ and $\mathrm{bigbnd}=⟨\mathit{\text{value}}⟩$.
On entry, the equal bounds on nonlinear constraint $⟨\mathit{\text{value}}⟩$ are infinite, because ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$, but $|\mathrm{beta}|\ge \mathrm{bigbnd}$: $\mathrm{beta}=⟨\mathit{\text{value}}⟩$ and $\mathrm{bigbnd}=⟨\mathit{\text{value}}⟩$.
On entry, the equal bounds on variable $⟨\mathit{\text{value}}⟩$ are infinite, because ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=\mathrm{beta}$, but $|\mathrm{beta}|\ge \mathrm{bigbnd}$: $\mathrm{beta}=⟨\mathit{\text{value}}⟩$ and $\mathrm{bigbnd}=⟨\mathit{\text{value}}⟩$.
On entry with a Warm Start, ${\mathbf{istate}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
${\mathbf{ifail}}<0$
User requested termination by setting mode negative in objfun or confun.
Overflow
If overflow occurs then either an element of $C$ is very large, or the singular values or singular vectors have been incorrectly supplied.
${\mathbf{ifail}}=-99$
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7Accuracy

If ${\mathbf{ifail}}={\mathbf{0}}$ on exit, then the vector returned in the array x is an estimate of the solution to an accuracy of approximately Optimality Tolerance ($\text{default value}={\epsilon }^{0.8}$, where $\epsilon$ is the machine precision).

8Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
e04usf/​e04usa is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
e04usf/​e04usa makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9.1Description of the Printed Output

This section describes the intermediate printout and final printout produced by e04usf/​e04usa. The intermediate printout is a subset of the monitoring information produced by the routine at every iteration (see Section 13). You can control the level of printed output (see the description of the optional parameter Major Print Level). Note that the intermediate printout and final printout are produced only if ${\mathbf{Major Print Level}}\ge 10$ (the default for e04usf, by default no output is produced by e04usa).
The following line of summary output ($\text{}<80$ characters) is produced at every major iteration. In all cases, the values of the quantities printed are those in effect on completion of the given iteration.
 Maj is the major iteration count. Mnr is the number of minor iterations required by the feasibility and optimality phases of the QP subproblem. Generally, Mnr will be $1$ in the later iterations, since theoretical analysis predicts that the correct active set will be identified near the solution (see Section 11 in e04uff/​e04ufa). Note that Mnr may be greater than the optional parameter Minor Iteration Limit if some iterations are required for the feasibility phase. Step is the step ${\alpha }_{k}$ taken along the computed search direction. On reasonably well-behaved problems, the unit step (i.e., ${\alpha }_{k}=1$) will be taken as the solution is approached. Merit Function is the value of the augmented Lagrangian merit function (see (12) in e04uff/​e04ufa) at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty parameters (see Section 11.3 in e04uff/​e04ufa). As the solution is approached, Merit Function will converge to the value of the objective function at the solution. If the QP subproblem does not have a feasible point (signified by I at the end of the current output line) then the merit function is a large multiple of the constraint violations, weighted by the penalty parameters. During a sequence of major iterations with infeasible subproblems, the sequence of Merit Function values will decrease monotonically until either a feasible subproblem is obtained or e04usf/​e04usa terminates with ${\mathbf{ifail}}={\mathbf{3}}$ (no feasible point could be found for the nonlinear constraints). If there are no nonlinear constraints present (i.e., ${\mathbf{ncnln}}=0$) then this entry contains Objective, the value of the objective function $F\left(x\right)$. The objective function will decrease monotonically to its optimal value when there are no nonlinear constraints. Norm Gz is $‖{Z}^{\mathrm{T}}{g}_{\mathrm{FR}}‖$, the Euclidean norm of the projected gradient (see Section 11.2 in e04uff/​e04ufa). Norm Gz will be approximately zero in the neighbourhood of a solution. Violtn is the Euclidean norm of the residuals of constraints that are violated or in the predicted active set (not printed if ncnln is zero). Violtn will be approximately zero in the neighbourhood of a solution. Cond Hz is a lower bound on the condition number of the projected Hessian approximation ${H}_{Z}$ (${H}_{Z}={Z}^{\mathrm{T}}{H}_{\mathrm{FR}}Z={R}_{Z}^{\mathrm{T}}{R}_{Z}$; see (6) and (11) in e04uff/​e04ufa). The larger this number, the more difficult the problem. M is printed if the quasi-Newton update has been modified to ensure that the Hessian approximation is positive definite (see Section 11.4 in e04uff/​e04ufa). I is printed if the QP subproblem has no feasible point. C is printed if central differences have been used to compute the unspecified objective and constraint gradients. If the value of Step is zero then the switch to central differences was made because no lower point could be found in the linesearch. (In this case, the QP subproblem is resolved with the central difference gradient and Jacobian.) If the value of Step is nonzero then central differences were computed because Norm Gz and Violtn imply that $x$ is close to a Kuhn–Tucker point (see Section 11.1 in e04uff/​e04ufa). L is printed if the linesearch has produced a relative change in $x$ greater than the value defined by the optional parameter Step Limit. If this output occurs frequently during later iterations of the run, optional parameter Step Limit should be set to a larger value. R is printed if the approximate Hessian has been refactorized. If the diagonal condition estimator of $R$ indicates that the approximate Hessian is badly conditioned then the approximate Hessian is refactorized using column interchanges. If necessary, $R$ is modified so that its diagonal condition estimator is bounded.
The final printout includes a listing of the status of every variable and constraint.
The following describes the printout for each variable. A full stop (.) is printed for any numerical value that is zero.
Varbl gives the name (V) and index $\mathit{j}$, for $\mathit{j}=1,2,\dots ,n$, of the variable.
State gives the state of the variable (FR if neither bound is in the working set, EQ if a fixed variable, LL if on its lower bound, UL if on its upper bound, TF if temporarily fixed at its current value). If Value lies outside the upper or lower bounds by more than the Feasibility Tolerance, State will be ++ or -- respectively.
A key is sometimes printed before State.
 A Alternative optimum possible. The variable is active at one of its bounds, but its Lagrange multiplier is essentially zero. This means that if the variable were allowed to start moving away from its bound then there would be no change to the objective function. The values of the other free variables might change, giving a genuine alternative solution. However, if there are any degenerate variables (labelled D), the actual change might prove to be zero, since one of them could encounter a bound immediately. In either case the values of the Lagrange multipliers might also change. D Degenerate. The variable is free, but it is equal to (or very close to) one of its bounds. I Infeasible. The variable is currently violating one of its bounds by more than the Feasibility Tolerance.
Value is the value of the variable at the final iteration.
Lower Bound is the lower bound specified for the variable. None indicates that ${\mathbf{bl}}\left(j\right)\le -\mathit{bigbnd}$.
Upper Bound is the upper bound specified for the variable. None indicates that ${\mathbf{bu}}\left(j\right)\ge \mathit{bigbnd}$.
Lagr Mult is the Lagrange multiplier for the associated bound. This will be zero if State is FR unless ${\mathbf{bl}}\left(j\right)\le -\mathit{bigbnd}$ and ${\mathbf{bu}}\left(j\right)\ge \mathit{bigbnd}$, in which case the entry will be blank. If $x$ is optimal, the multiplier should be non-negative if State is LL and non-positive if State is UL.
Slack is the difference between the variable Value and the nearer of its (finite) bounds ${\mathbf{bl}}\left(j\right)$ and ${\mathbf{bu}}\left(j\right)$. A blank entry indicates that the associated variable is not bounded (i.e., ${\mathbf{bl}}\left(j\right)\le -\mathit{bigbnd}$ and ${\mathbf{bu}}\left(j\right)\ge \mathit{bigbnd}$).
The meaning of the printout for linear and nonlinear constraints is the same as that given above for variables, with ‘variable’ replaced by ‘constraint’, ${\mathbf{bl}}\left(j\right)$ and ${\mathbf{bu}}\left(j\right)$ are replaced by ${\mathbf{bl}}\left(n+j\right)$ and ${\mathbf{bu}}\left(n+j\right)$ respectively, and with the following changes in the heading:
 L Con gives the name (L) and index $\mathit{j}$, for $\mathit{j}=1,2,\dots ,{n}_{L}$, of the linear constraint. N Con gives the name (N) and index ($\mathit{j}-{n}_{L}$), for $\mathit{j}={n}_{L}+1,\dots ,{n}_{L}+{n}_{N}$, of the nonlinear constraint.
Note that movement off a constraint (as opposed to a variable moving away from its bound) can be interpreted as allowing the entry in the Slack column to become positive.
Numerical values are output with a fixed number of digits; they are not guaranteed to be accurate to this precision.

10Example

This example is based on Problem 57 in Hock and Schittkowski (1981) and involves the minimization of the sum of squares function
 $F(x) = 12 ∑ i=1 44 (yi-fi(x)) 2 ,$
where
 $fi (x) = x1 + (0.49-x1) e -x2 (ai-8)$
and
 $i yi ai i yi ai 1 0.49 8 23 0.41 22 2 0.49 8 24 0.40 22 3 0.48 10 25 0.42 24 4 0.47 10 26 0.40 24 5 0.48 10 27 0.40 24 6 0.47 10 28 0.41 26 7 0.46 12 29 0.40 26 8 0.46 12 30 0.41 26 9 0.45 12 31 0.41 28 10 0.43 12 32 0.40 28 11 0.45 14 33 0.40 30 12 0.43 14 34 0.40 30 13 0.43 14 35 0.38 30 14 0.44 16 36 0.41 32 15 0.43 16 37 0.40 32 16 0.43 16 38 0.40 34 17 0.46 18 39 0.41 36 18 0.45 18 40 0.38 36 19 0.42 20 41 0.40 38 20 0.42 20 42 0.40 38 21 0.43 20 43 0.39 40 22 0.41 22 44 0.39 42$
subject to the bounds
 $x1≥-0.4 x2≥-4.0$
to the general linear constraint
 $x1+x2≥1.0$
and to the nonlinear constraint
 $0.49x2-x1 x2≥ 0.09 .$
The initial point, which is infeasible, is
 $x0=(0.4,0.0)T$
and $F\left({x}_{0}\right)=0.002241$.
The optimal solution (to five figures) is
 $x*=(0.41995,1.28484)T,$
and $F\left({x}^{*}\right)=0.01423$. The nonlinear constraint is active at the solution.
The document for e04uqf/​e04uqa includes an example program to solve the same problem using some of the optional parameters described in Section 12.

10.1Program Text

Note: the following programs illustrate the use of e04usf and e04usa.
Program Text (e04usfe.f90)
Program Text (e04usae.f90)

10.2Program Data

Program Data (e04usfe.d)
Program Data (e04usae.d)

10.3Program Results

Program Results (e04usfe.r)
Program Results (e04usae.r)
Note: the remainder of this document is intended for more advanced users. Section 12 describes the optional parameters which may be set by calls to e04uqf/​e04uqa and/or e04urf/​e04ura. Section 13 describes the quantities which can be requested to monitor the course of the computation.

11Algorithmic Details

e04usf/​e04usa implements a Sequential Quadratic Programming (SQP) method incorporating an augmented Lagrangian merit function and a BFGS (Broyden–Fletcher–Goldfarb–Shanno) quasi-Newton approximation to the Hessian of the Lagrangian, and is based on e04wdf. The documents for e04ncf/​e04nca, e04uff/​e04ufa and e04wdf should be consulted for details of the method.

12Optional Parameters

Several optional parameters in e04usf/​e04usa define choices in the problem specification or the algorithm logic. In order to reduce the number of formal arguments of e04usf/​e04usa these optional parameters have associated default values that are appropriate for most problems. Therefore, you need only specify those optional parameters whose values are to be different from their default values.
The remainder of this section can be skipped if you wish to use the default values for all optional parameters.
The following is a list of the optional parameters available. A full description of each optional parameter is provided in Section 12.1.
Optional parameters may be specified by calling one, or both, of e04uqf/​e04uqa and e04urf/​e04ura before a call to e04usf/​e04usa.
e04uqf/​e04uqa reads options from an external options file, with Begin and End as the first and last lines respectively and each intermediate line defining a single optional parameter. For example,
```Begin
Print level = 1
End```
The call
`Call e04uqf/​e04uqa (ioptns, inform)`
can then be used to read the file on unit ioptns. inform will be zero on successful exit. e04uqf/​e04uqa should be consulted for a full description of this method of supplying optional parameters.
e04urf/​e04ura can be called to supply options directly, one call being necessary for each optional parameter. For example,
`Call e04urf ('Print Level = 1')`
e04urf/​e04ura should be consulted for a full description of this method of supplying optional parameters.
All optional parameters not specified by you are set to their default values. Optional parameters specified by you are unaltered by e04usf/​e04usa (unless they define invalid values) and so remain in effect for subsequent calls to e04usf/​e04usa, unless altered by you.

12.1Description of the Optional Parameters

For each option, we give a summary line, a description of the optional parameter and details of constraints.
The summary line contains:
• the keywords, where the minimum abbreviation of each keyword is underlined (if no characters of an optional qualifier are underlined, the qualifier may be omitted);
• a parameter value, where the letters $a$, $i$ and $r$ denote options that take character, integer and real values respectively;
• the default value, where the symbol $\epsilon$ is a generic notation for machine precision (see x02ajf), and ${\epsilon }_{r}$ denotes the relative precision of the objective function Function Precision.
Keywords and character values are case and white space insensitive.
Further details of other quantities not explicitly defined in this section may be found by consulting the document for e04uff/​e04ufa.
 Central Difference Interval $r$ Default values are computed
If the algorithm switches to central differences because the forward-difference approximation is not sufficiently accurate, the value of $r$ is used as the difference interval for every element of $x$. The switch to central differences is indicated by C at the end of each line of intermediate printout produced by the major iterations (see Section 9.1). The use of finite differences is discussed further under the optional parameter Difference Interval.
If you supply a value for this optional parameter, a small value between $0.0$ and $1.0$ is appropriate.
 Cold Start Default
 Warm Start
This option controls the specification of the initial working set in both the procedure for finding a feasible point for the linear constraints and bounds, and in the first QP subproblem thereafter. With a Cold Start, the first working set is chosen by e04usf/​e04usa based on the values of the variables and constraints at the initial point. Broadly speaking, the initial working set will include equality constraints and bounds or inequality constraints that violate or ‘nearly’ satisfy their bounds (to within Crash Tolerance).
With a Warm Start, you must set the istate array and define clamda and r as discussed in Section 5. istate values associated with bounds and linear constraints determine the initial working set of the procedure to find a feasible point with respect to the bounds and linear constraints. istate values associated with nonlinear constraints determine the initial working set of the first QP subproblem after such a feasible point has been found. e04usf/​e04usa will override your specification of istate if necessary, so that a poor choice of the working set will not cause a fatal error. For instance, any elements of istate which are set to $-2$, $-1$ or $4$ will be reset to zero, as will any elements which are set to $3$ when the corresponding elements of bl and bu are not equal. A Warm Start will be advantageous if a good estimate of the initial working set is available – for example, when e04usf/​e04usa is called repeatedly to solve related problems.
 Crash Tolerance $r$ Default $\text{}=0.01$
This value is used in conjunction with the optional parameter Cold Start (the default value) when e04usf/​e04usa selects an initial working set. If $0\le r\le 1$, the initial working set will include (if possible) bounds or general inequality constraints that lie within $r$ of their bounds. In particular, a constraint of the form ${a}_{j}^{\mathrm{T}}x\ge l$ will be included in the initial working set if $|{a}_{j}^{\mathrm{T}}x-l|\le r\left(1+|l|\right)$. If $r<0$ or $r>1$, the default value is used.
 Defaults
This special keyword may be used to reset all optional parameters to their default values.
 Derivative Level $i$ Default $\text{}=3$
This parameter indicates which derivatives are provided in user-supplied subroutines objfun and confun. The possible choices for $i$ are the following.
$\mathbit{i}$ Meaning
3 All elements of the objective Jacobian and the constraint Jacobian are provided by you.
2 All elements of the constraint Jacobian are provided, but some elements of the objective Jacobian are not specified by you.
1 All elements of the objective Jacobian are provided, but some elements of the constraint Jacobian are not specified by you.
0 Some elements of both the objective Jacobian and the constraint Jacobian are not specified by you.
The value $i=3$ should be used whenever possible, since e04usf/​e04usa is more reliable (and will usually be more efficient) when all derivatives are exact.
If $i=0$ or $2$, e04usf/​e04usa will approximate unspecified elements of the objective Jacobian, using finite differences. The computation of finite difference approximations usually increases the total run-time, since a call to objfun is required for each unspecified element. Furthermore, less accuracy can be attained in the solution (see Chapter 8 of Gill et al. (1981), for a discussion of limiting accuracy).
If $i=0$ or $1$, e04usf/​e04usa will approximate unspecified elements of the constraint Jacobian. One call to confun is needed for each variable for which partial derivatives are not available. For example, if the constraint Jacobian has the form
 $( * * * * * ? ? * * * ? * * * * * )$
where ‘$*$’ indicates an element provided by you and ‘?’ indicates an unspecified element, e04usf/​e04usa will call confun twice: once to estimate the missing element in column $2$, and again to estimate the two missing elements in column $3$. (Since columns $1$ and $4$ are known, they require no calls to confun.)
At times, central differences are used rather than forward differences, in which case twice as many calls to objfun and confun are needed. (The switch to central differences is not under your control.)
If $i<0$ or $i>3$, the default value is used.
 Difference Interval $r$ Default values are computed
This option defines an interval used to estimate derivatives by finite differences in the following circumstances:
1. (a)For verifying the objective and/or constraint gradients (see the description of the optional parameter Verify).
2. (b)For estimating unspecified elements of the objective and/or constraint Jacobian matrix.
In general, a derivative with respect to the $j$th variable is approximated using the interval ${\delta }_{j}$, where ${\delta }_{j}=r\left(1+|{\stackrel{^}{x}}_{j}|\right)$, with $\stackrel{^}{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 $\mathit{O}\left(r\right)$. See Gill et al. (1981) for a discussion of the accuracy in finite difference approximations.
If a difference interval is not specified, 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 e04usf/​e04usa determine constant elements in the objective and constraint gradients (see the descriptions of confun and objfun in Section 5).
If you supply a value for this optional parameter, a small value between $0.0$ and $1.0$ is appropriate.
 Feasibility Tolerance $r$ Default $\text{}=\sqrt{\epsilon }$
The scalar $r$ defines the maximum acceptable absolute violations in linear and nonlinear constraints at a ‘feasible’ point; i.e., a constraint is considered satisfied if its violation does not exceed $r$. If $r<\epsilon$ or $r\ge 1$, the default value is used. Using this keyword sets both optional parameters Linear Feasibility Tolerance and Nonlinear Feasibility Tolerance to $r$, if $\epsilon \le r<1$. (Additional details are given under the descriptions of these optional parameters.)
 Function Precision $r$ Default $\text{}={\epsilon }^{0.9}$
This parameter defines ${\epsilon }_{r}$, which is intended to be a measure of the accuracy with which the problem functions $F\left(x\right)$ and $c\left(x\right)$ can be computed. If $r<\epsilon$ or $r\ge 1$, the default value is used.
The value of ${\epsilon }_{r}$ should reflect the relative precision of $1+|F\left(x\right)|$; i.e., ${\epsilon }_{r}$ acts as a relative precision when $|F|$ is large and as an absolute precision when $|F|$ is small. For example, if $F\left(x\right)$ is typically of order $1000$ and the first six significant digits are known to be correct, an appropriate value for ${\epsilon }_{r}$ would be ${10}^{-6}$. In contrast, if $F\left(x\right)$ is typically of order ${10}^{-4}$ and the first six significant digits are known to be correct, an appropriate value for ${\epsilon }_{r}$ would be ${10}^{-10}$. The choice of ${\epsilon }_{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 ${\epsilon }_{r}$ should be large enough so that e04usf/​e04usa will not attempt to distinguish between function values that differ by less than the error inherent in the calculation.
 Hessian $\overline{)\mathbf{Y}}\mathbf{es}/\overline{)\mathbf{N}}\mathbf{o}$ Default $=\mathrm{NO}$
This option controls the contents of the upper triangular matrix $R$ (see Section 5). e04usf/​e04usa works exclusively with the transformed and reordered Hessian ${H}_{Q}$, and hence extra computation is required to form the Hessian itself. If ${\mathbf{Hessian}}=\mathrm{NO}$, r contains the Cholesky factor of the transformed and reordered Hessian. If ${\mathbf{Hessian}}=\mathrm{YES}$, the Cholesky factor of the approximate Hessian itself is formed and stored in r. You should select ${\mathbf{Hessian}}=\mathrm{YES}$ if a Warm Start will be used for the next call to e04usf/​e04usa.
 Infinite Bound Size $r$ Default $\text{}={10}^{20}$
If $r>0$, $r$ defines the ‘infinite’ bound $\mathit{bigbnd}$ in the definition of the problem constraints. Any upper bound greater than or equal to $\mathit{bigbnd}$ will be regarded as $+\infty$ (and similarly any lower bound less than or equal to $-\mathit{bigbnd}$ will be regarded as $-\infty$). If $r<0$, the default value is used.
 Infinite Step Size $r$ Default $\text{}=\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(\mathit{bigbnd},{10}^{20}\right)$
If $r>0$, $r$ specifies the magnitude of the change in variables that is treated as a step to an unbounded solution. If the change in $x$ during an iteration would exceed the value of $r$, the objective function is considered to be unbounded below in the feasible region. If $r\le 0$, the default value is used.
 JTJ Initial Hessian Default
 Unit Initial Hessian
This option controls the initial value of the upper triangular matrix $R$. If $J$ denotes the objective Jacobian matrix $\nabla f\left(x\right)$, ${J}^{\mathrm{T}}J$ is often a good approximation to the objective Hessian matrix ${\nabla }^{2}F\left(x\right)$ (see also optional parameter Reset Frequency).
 Line Search Tolerance $r$ Default $\text{}=0.9$
The value $r$ ($0\le r<1$) controls the accuracy with which the step $\alpha$ taken during each iteration approximates a minimum of the merit function along the search direction (the smaller the value of $r$, the more accurate the linesearch). The default value $r=0.9$ requests an inaccurate search and is appropriate for most problems, particularly those with any nonlinear constraints.
If there are no nonlinear constraints, a more accurate search may be appropriate when it is desirable to reduce the number of major iterations – for example, if the objective function is cheap to evaluate, or if a substantial number of derivatives are unspecified. If $r<0$ or $r\ge 1$, the default value is used.
 Linear Feasibility Tolerance ${r}_{1}$ Default $\text{}=\sqrt{\epsilon }$
 Nonlinear Feasibility Tolerance ${r}_{2}$ Default $\text{}={\epsilon }^{0.33}$ or $\sqrt{\epsilon }$
The default value of ${r}_{2}$ is ${\epsilon }^{0.33}$ if ${\mathbf{Derivative Level}}=0$ or $1$, and $\sqrt{\epsilon }$ otherwise.
The scalars ${r}_{1}$ and ${r}_{2}$ define the maximum acceptable absolute violations in linear and nonlinear constraints at a ‘feasible’ point; i.e., a linear constraint is considered satisfied if its violation does not exceed ${r}_{1}$, and similarly for a nonlinear constraint and ${r}_{2}$. If ${r}_{m}<\epsilon$ or ${r}_{\mathit{m}}\ge 1$, the default value is used, for $\mathit{m}=1,2$.
On entry to e04usf/​e04usa, 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 ${r}_{1}$. All subsequent iterates will satisfy the linear constraints to within the same tolerance (unless ${r}_{1}$ is comparable to the finite difference interval).
For nonlinear constraints, the feasibility tolerance ${r}_{2}$ defines the largest constraint violation that is acceptable at an optimal point. Since nonlinear constraints are generally not satisfied until the final iterate, the value of optional parameter Nonlinear Feasibility Tolerance acts as a partial termination criterion for the iterative sequence generated by e04usf/​e04usa (see also optional parameter Optimality Tolerance).
These tolerances should reflect the precision of the corresponding constraints. For example, if the variables and the coefficients in the linear constraints are of order unity, and the latter are correct to about $6$ decimal digits, it would be appropriate to specify ${r}_{1}$ as ${10}^{-6}$.
 List Default for e04usf $\text{}={\mathbf{List}}$
 Nolist Default for e04usa $\text{}={\mathbf{Nolist}}$
Optional parameter List enables printing of each optional parameter specification as it is supplied. Nolist suppresses this printing.
 Major Iteration Limit $i$ Default $\text{}=\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(50,3\left(n+{n}_{L}\right)+10{n}_{N}\right)$
 Iteration Limit $i$
 Iters $i$
 Itns $i$
The value of $i$ specifies the maximum number of major iterations allowed before termination. Setting $i=0$ and ${\mathbf{Major Print Level}}>0$ means that the workspace needed will be computed and printed, but no iterations will be performed. If $i<0$, the default value is used.
 Major Print Level $i$ Default for e04usf $\text{}=10$
 Print Level $i$ Default for e04usa $\text{}=0$
The value of $i$ controls the amount of printout produced by the major iterations of e04usf/​e04usa, as indicated below. A detailed description of the printed output is given in Section 9.1 (summary output at each major iteration and the final solution) and Section 13 (monitoring information at each major iteration). (See also the description of the optional parameter Minor Print Level.)
The following printout is sent to the current advisory message unit (as defined by x04abf):
$\mathbit{i}$ Output
$\phantom{\ge 0}0$ No output.
$\phantom{\ge 0}1$ The final solution only.
$\phantom{\ge 0}5$ One line of summary output ($\text{}<80$ characters; see Section 9.1) for each major iteration (no printout of the final solution).
$\text{}\ge 10$ The final solution and one line of summary output for each major iteration.
The following printout is sent to the unit number given by the optional parameter Monitoring File:
$\mathbit{i}$ Output
$\text{}<5$ No output.
$\text{}\ge 5$ One long line of output ($\text{}>80$ characters; see Section 13) for each major iteration (no printout of the final solution).
$\text{}\ge 20$ At each major iteration, the objective function, the Euclidean norm of the nonlinear constraint violations, the values of the nonlinear constraints (the vector $c$), the values of the linear constraints (the vector ${A}_{L}x$), and the current values of the variables (the vector $x$).
$\text{}\ge 30$ At each major iteration, the diagonal elements of the matrix $T$ associated with the $TQ$ factorization (see (5) in e04uff/​e04ufa) of the QP working set, and the diagonal elements of $R$, the triangular factor of the transformed and reordered Hessian (see (6) in e04uff/​e04ufa).
If ${\mathbf{Major Print Level}}\ge 5$ and the unit number defined by the optional parameter Monitoring File is the same as that defined by x04abf, the summary output for each major iteration is suppressed.
 Minor Iteration Limit $i$ Default $\text{}=\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(50,3\left(n+{n}_{L}+{n}_{N}\right)\right)$
The value of $i$ specifies the maximum number of iterations for finding a feasible point with respect to the bounds and linear constraints (if any). The value of $i$ also specifies the maximum number of minor iterations for the optimality phase of each QP subproblem. If $i\le 0$, the default value is used.
 Minor Print Level $i$ Default $\text{}=0$
The value of $i$ controls the amount of printout produced by the minor iterations of e04usf/​e04usa (i.e., the iterations of the quadratic programming algorithm), as indicated below. A detailed description of the printed output is given in Section 9.1 (summary output at each minor iteration and the final QP solution) and Section 13 (monitoring information at each minor iteration). (See also the description of the optional parameter Major Print Level.)
The following printout is sent to the current advisory message unit (as defined by x04abf):
$\mathbit{i}$ Output
$\phantom{\ge 0}0$ No output.
$\phantom{\ge 0}1$ The final QP solution only.
$\phantom{\ge 0}5$ One line of summary output ($\text{}<80$ characters; see Section 9.1) for each minor iteration (no printout of the final QP solution).
$\text{}\ge 10$ The final QP solution and one line of summary output for each minor iteration.
The following printout is sent to the unit number given by the optional parameter Monitoring File:
$\mathbit{i}$ Output
$\text{}<5$ No output.
$\text{}\ge 5$ One long line of output ($\text{}>80$ characters; see Section 13) for each minor iteration (no printout of the final QP solution).
$\text{}\ge 20$ At each minor iteration, the current estimates of the QP multipliers, the current estimate of the QP search direction, the QP constraint values, and the status of each QP constraint.
$\text{}\ge 30$ At each minor iteration, the diagonal elements of the matrix $T$ associated with the $TQ$ factorization (see (5) in e04uff/​e04ufa) of the QP working set, and the diagonal elements of the Cholesky factor $R$ of the transformed Hessian (see (6) in e04uff/​e04ufa).
If ${\mathbf{Major Print Level}}\ge 5$ and the unit number defined by the optional parameter Monitoring File is the same as that defined by x04abf, the summary output for each major iteration is suppressed.
 Monitoring File $i$ Default $\text{}=-1$
If $i\ge 0$ and ${\mathbf{Major Print Level}}\ge 5$ or $i\ge 0$ and ${\mathbf{Minor Print Level}}\ge 5$, monitoring information produced by e04usf/​e04usa at every iteration is sent to a file with logical unit number $i$. If $i<0$ and/or ${\mathbf{Major Print Level}}<5$ and ${\mathbf{Minor Print Level}}<5$, no monitoring information is produced.
 Optimality Tolerance $r$ Default $\text{}={\epsilon }_{R}^{0.8}$
The parameter $r$ (${\epsilon }_{R}\le r<1$) specifies the accuracy to which you wish the final iterate to approximate a solution of the problem. Broadly speaking, $r$ indicates the number of correct figures desired in the objective function at the solution. For example, if $r$ is ${10}^{-6}$ and e04usf/​e04usa terminates successfully, the final value of $F$ should have approximately six correct figures. If $r<{\epsilon }_{R}$ or $r\ge 1$, the default value is used.
e04usf/​e04usa will terminate successfully if the iterative sequence of $x$ values is judged to have converged and the final point satisfies the first-order Kuhn–Tucker conditions (see Section 11.1 in e04uff/​e04ufa). The sequence of iterates is considered to have converged at $x$ if
 $α‖p‖≤r(1+‖x‖),$ (2)
where $p$ is the search direction and $\alpha$ the step length. An iterate is considered to satisfy the first-order conditions for a minimum if
 $‖ Z T g FR ‖ ≤ r (1+max( 1 + |F(x)| ,‖ g FR ‖))$ (3)
and
 $|resj|≤ftol for all j,$ (4)
where ${Z}^{\mathrm{T}}{g}_{\mathrm{FR}}$ is the projected gradient, ${g}_{\mathrm{FR}}$ is the gradient of $F\left(x\right)$ with respect to the free variables, ${\mathit{res}}_{j}$ is the violation of the $j$th active nonlinear constraint, and $\mathit{ftol}$ is the Nonlinear Feasibility Tolerance.
 Reset Frequency $i$ Default $\text{}=2$
If $i>0$, this parameter allows you to reset the approximate Hessian matrix to ${J}^{\mathrm{T}}J$ every $i$ iterations, where $J$ is the objective Jacobian matrix $\nabla f\left(x\right)$ (see also the description of the optional parameter JTJ Initial Hessian).
At any point where there are no nonlinear constraints active and the values of $f$ are small in magnitude compared to the norm of $J$, ${J}^{\mathrm{T}}J$ will be a good approximation to the objective Hessian ${\nabla }^{2}F\left(x\right)$. Under these circumstances, frequent resetting can significantly improve the convergence rate of e04usf/​e04usa.
Resetting is suppressed at any iteration during which there are nonlinear constraints active.
If $i\le 0$, the default value is used.
 Start Objective Check At Variable ${i}_{1}$ Default $\text{}=1$
 Stop Objective Check At Variable ${i}_{2}$ Default $\text{}=n$
 Start Constraint Check At Variable ${i}_{3}$ Default $\text{}=1$
 Stop Constraint Check At Variable ${i}_{4}$ Default $\text{}=n$
These keywords take effect only if ${\mathbf{Verify Level}}>0$. They may be used to control the verification of Jacobian elements computed by user-supplied subroutines objfun and confun. For example, if the first $30$ columns of the objective Jacobian appeared to be correct in an earlier run, so that only column $31$ remains questionable, it is reasonable to specify ${\mathbf{Start Objective Check At Variable}}=31$. If the first $30$ variables appear linearly in the subfunctions, so that the corresponding Jacobian elements are constant, the above choice would also be appropriate.
If ${i}_{2\mathit{m}-1}\le 0$ or ${i}_{2\mathit{m}-1}>\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left(n,{i}_{2\mathit{m}}\right)$, the default value is used, for $\mathit{m}=1,2$. If ${i}_{2\mathit{m}}\le 0$ or ${i}_{2\mathit{m}}>n$, the default value is used, for $\mathit{m}=1,2$.
 Step Limit $r$ Default $\text{}=2.0$
If $r>0,r$ specifies the maximum change in variables at the first step of the linesearch. In some cases, such as $F\left(x\right)=a{e}^{bx}$ or $F\left(x\right)=a{x}^{b}$, even a moderate change in the elements of $x$ can lead to floating-point overflow. The parameter $r$ is, therefore, used to encourage evaluation of the problem functions at meaningful points. Given any major iterate $x$, the first point $\stackrel{~}{x}$ at which $F$ and $c$ are evaluated during the linesearch is restricted so that
 $‖x~-x‖2≤r(1+‖x‖2).$
The linesearch may go on and evaluate $F$ and $c$ at points further from $x$ if this will result in a lower value of the merit function (indicated by L at the end of each line of output produced by the major iterations; see Section 9.1). If L is printed for most of the iterations, $r$ should be set to a larger value.
Wherever possible, upper and lower bounds on $x$ should be used to prevent evaluation of nonlinear functions at wild values. The default value ${\mathbf{Step Limit}}=2.0$ should not affect progress on well-behaved functions, but values such as $0.1$ or $0.01$ may be helpful when rapidly varying functions are present. If a small value of Step Limit is selected, a good starting point may be required. An important application is to the class of nonlinear least squares problems. If $r\le 0$, the default value is used.
 Verify Level $i$ Default $\text{}=0$
 Verify
These keywords refer to finite difference checks on the gradient elements computed by objfun and confun. (Unspecified gradient elements are not checked.) The possible choices for $i$ are the following:
$\mathbit{i}$ Meaning
$-1$ No checks are performed.
$\phantom{-}0$ Only a ‘cheap’ test will be performed, requiring one call to objfun.
$\ge 1$ Individual gradient elements will also be checked using a reliable (but more expensive) test.
It is possible to specify ${\mathbf{Verify Level}}=0$ to $3$ in several ways. For example, the nonlinear objective gradient (if any) will be verified if either Verify Objective Gradients or ${\mathbf{Verify Level}}=1$ is specified. Similarly, the objective and the constraint gradients will be verified if ${\mathbf{Verify}}=\mathrm{YES}$ or ${\mathbf{Verify Level}}=3$ or Verify is specified.
If $i=-1$, no checking will be performed.
If $0\le i\le 3$, gradients will be verified at the first point that satisfies the linear constraints and bounds.
If $i=0$, only a ‘cheap’ test will be performed, requiring one call to objfun and (if appropriate) one call to confun.
If $1\le i\le 3$, a more reliable (but more expensive) check will be made on individual gradient elements, within the ranges specified by the Start Objective Check At Variable and Stop Objective Check At Variable keywords. A result of the form OK or BAD? is printed by e04usf/​e04usa to indicate whether or not each element appears to be correct. If a gradient element is determined to be extremely poor (i.e., if it appears to have no significant digits of accuracy at all), then e04usf/​e04usa will also exit with an error indicator in argument ifail.
If $10\le i\le 13$, the action is the same as for $i-10$, except that it will take place at the user-specified initial value of $x$.
If $i<-1$ or $4\le i\le 9$ or $i>13$, the default value is used.
We suggest that ${\mathbf{Verify Level}}=3$ be used whenever a new function routine is being developed.

13Description of Monitoring Information

This section describes the long line of output ($\text{}>80$ characters) which forms part of the monitoring information produced by e04usf/​e04usa. (See also the description of the optional parameters Major Print Level, Minor Print Level and Monitoring File.) You can control the level of printed output.
When ${\mathbf{Major Print Level}}\ge 5$ and ${\mathbf{Monitoring File}}\ge 0$, the following line of output is produced at every major iteration of e04usf/​e04usa on the unit number specified by optional parameter Monitoring File. In all cases, the values of the quantities printed are those in effect on completion of the given iteration.
 Maj is the major iteration count. Mnr is the number of minor iterations required by the feasibility and optimality phases of the QP subproblem. Generally, Mnr will be $1$ in the later iterations, since theoretical analysis predicts that the correct active set will be identified near the solution (see Section 11 in e04uff/​e04ufa). Note that Mnr may be greater than the optional parameter Minor Iteration Limit if some iterations are required for the feasibility phase. Step is the step ${\alpha }_{k}$ taken along the computed search direction. On reasonably well-behaved problems, the unit step (i.e., ${\alpha }_{k}=1$) will be taken as the solution is approached. Nfun is the cumulative number of evaluations of the objective function needed for the linesearch. Evaluations needed for the estimation of the gradients by finite differences are not included. Nfun is printed as a guide to the amount of work required for the linesearch. Merit Function is the value of the augmented Lagrangian merit function (see (12) in e04uff/​e04ufa) at the current iterate. This function will decrease at each iteration unless it was necessary to increase the penalty parameters (see Section 11.3 in e04uff/​e04ufa). As the solution is approached, Merit Function will converge to the value of the objective function at the solution. If the QP subproblem does not have a feasible point (signified by I at the end of the current output line) then the merit function is a large multiple of the constraint violations, weighted by the penalty parameters. During a sequence of major iterations with infeasible subproblems, the sequence of Merit Function values will decrease monotonically until either a feasible subproblem is obtained or e04usf/​e04usa terminates with ${\mathbf{ifail}}={\mathbf{3}}$ (no feasible point could be found for the nonlinear constraints). If there are no nonlinear constraints present (i.e., ${\mathbf{ncnln}}=0$) then this entry contains Objective, the value of the objective function $F\left(x\right)$. The objective function will decrease monotonically to its optimal value when there are no nonlinear constraints. Norm Gz is $‖{Z}^{\mathrm{T}}{g}_{\mathrm{FR}}‖$, the Euclidean norm of the projected gradient (see Section 11.2 in e04uff/​e04ufa). Norm Gz will be approximately zero in the neighbourhood of a solution. Violtn is the Euclidean norm of the residuals of constraints that are violated or in the predicted active set (not printed if ncnln is zero). Violtn will be approximately zero in the neighbourhood of a solution. Nz is the number of columns of $Z$ (see Section 11.2 in e04uff/​e04ufa). The value of Nz is the number of variables minus the number of constraints in the predicted active set; i.e., $\mathtt{Nz}=n-\left(\mathtt{Bnd}+\mathtt{Lin}+\mathtt{Nln}\right)$. Bnd is the number of simple bound constraints in the current working set. Lin is the number of general linear constraints in the current working set. Nln is the number of nonlinear constraints in the predicted active set (not printed if ncnln is zero). Penalty is the Euclidean norm of the vector of penalty parameters used in the augmented Lagrangian merit function (not printed if ncnln is zero). Cond H is a lower bound on the condition number of the Hessian approximation $H$. Cond Hz is a lower bound on the condition number of the projected Hessian approximation ${H}_{Z}$ (${H}_{Z}={Z}^{\mathrm{T}}{H}_{\mathrm{FR}}Z={R}_{Z}^{\mathrm{T}}{R}_{Z}$; see (6) and (11) in e04uff/​e04ufa). The larger this number, the more difficult the problem. Cond T is a lower bound on the condition number of the matrix of predicted active constraints. Conv is a three-letter indication of the status of the three convergence tests (2)–(4) defined in the description of the optional parameter Optimality Tolerance. Each letter is T if the test is satisfied and F otherwise. The three tests indicate whether: (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 e04usf/​e04usa terminates with ${\mathbf{ifail}}={\mathbf{0}}$, you should check the solution carefully. M is printed if the quasi-Newton update has been modified to ensure that the Hessian approximation is positive definite (see Section 11.4 in e04uff/​e04ufa). I is printed if the QP subproblem has no feasible point. C is printed if central differences have been used to compute the unspecified objective and constraint gradients. If the value of Step is zero then the switch to central differences was made because no lower point could be found in the linesearch. (In this case, the QP subproblem is resolved with the central difference gradient and Jacobian.) If the value of Step is nonzero then central differences were computed because Norm Gz and Violtn imply that $x$ is close to a Kuhn–Tucker point (see Section 11.1 in e04uff/​e04ufa). L is printed if the linesearch has produced a relative change in $x$ greater than the value defined by the optional parameter Step Limit. If this output occurs frequently during later iterations of the run, optional parameter Step Limit should be set to a larger value. R is printed if the approximate Hessian has been refactorized. If the diagonal condition estimator of $R$ indicates that the approximate Hessian is badly conditioned then the approximate Hessian is refactorized using column interchanges. If necessary, $R$ is modified so that its diagonal condition estimator is bounded.