NAG FL Interface
e04usf  (lsq_gencon_deriv_old)
e04usa (lsq_gencon_deriv)

1 Purpose

2 Specification

2.1 Specification for e04usf

2.2 Specification for e04usa

3 Description

4 References

5 Arguments

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 \max \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 \max \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 $\left|\beta \right|<\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$, $\left|\beta \right|<\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 ($=\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, ncnln, n, ldcj, needc, x, c, cjac, nstate, iuser, ruser) 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)

C Header Interface

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[])

C++ Header Interface

#include <nag.h> extern "C" { 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

$$\nabla c_i={\left(\frac{\partial c_i}{\partial x_1},\frac{\partial c_i}{\partial x_2},\dots ,\frac{\partial c_i}{\partial x_n}\right)}^{\mathrm{T}}\text{,}$$

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)\times \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\times \mathbf{x}\left(1\right)-5\times \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 ($=\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, needfi, x, f, fjac, nstate, iuser, ruser) 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)

C Header Interface

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[])

C++ Header Interface

#include <nag.h> extern "C" { 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

$$\nabla f_i={\left(\frac{\partial f_i}{\partial x_1},\frac{\partial f_i}{\partial x_2},\dots ,\frac{\partial f_i}{\partial x_n}\right)}^{\mathrm{T}}\text{,}$$

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(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(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(\max \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}}\tilde{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\times \mathbf{n}+\mathbf{nclin}+2\times \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\times \mathbf{n}+\mathbf{m}\times \left(\mathbf{n}+3\right)$;
• if $\mathbf{ncnln}=0$ and $\mathbf{nclin}>0$, $$\begin{gathered} \mathbf{lwork}\ge 2\times {\mathbf{n}}^2+20\times \mathbf{n}+11\times \mathbf{nclin}+ \\ \mathbf{m}\times \left(\mathbf{n}+3\right) \end{gathered}$$;
• if $\mathbf{ncnln}>0$ and $\mathbf{nclin}\ge 0$, $$\begin{gathered} \mathbf{lwork}\ge 2\times {\mathbf{n}}^2+\mathbf{n}\times \mathbf{nclin}+2\times \mathbf{n}\times \\ \mathbf{ncnln}+20\times \mathbf{n}+11\times \mathbf{nclin}+21\times \mathbf{ncnln}+\mathbf{m}\times \left(\mathbf{n}+3\right) \end{gathered}$$.

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.

6 Error Indicators and Warnings

$\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}=\max \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 \max \left(1,\mathbf{nclin}\right)$.

On entry, $\mathbf{ldcj}=〈\mathit{\text{value}}〉$ and $\mathbf{ncnln}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ldcj}\ge \max \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 $\left|\mathrm{beta}\right|\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 $\left|\mathrm{beta}\right|\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 $\left|\mathrm{beta}\right|\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 $\left|\mathrm{beta}\right|\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.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

9.1 Description of the Printed Output

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

11 Algorithmic Details

12 Optional Parameters

• Central Difference Interval
• Cold Start
• Crash Tolerance
• Defaults
• Derivative Level
• Difference Interval
• Feasibility Tolerance
• Function Precision
• Hessian
• Infinite Bound Size
• Infinite Step Size
• Iteration Limit
• Iters
• Itns
• JTJ Initial Hessian
• Linear Feasibility Tolerance
• Line Search Tolerance
• List
• Major Iteration Limit
• Major Print Level
• Minor Iteration Limit
• Minor Print Level
• Monitoring File
• Nolist
• Nonlinear Feasibility Tolerance
• Optimality Tolerance
• Print Level
• Reset Frequency
• Start Constraint Check At Variable
• Start Objective Check At Variable
• Step Limit
• Stop Constraint Check At Variable
• Stop Objective Check At Variable
• Unit Initial Hessian
• Verify
• Verify Constraint Gradients
• Verify Gradients
• Verify Level
• Verify Objective Gradients
• Warm Start

Begin
  Print level = 1
End

Call e04uqf/​e04uqa (ioptns, inform)

Call e04urf ('Print Level = 1')

12.1 Description of the Optional Parameters

• 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.