# NAG FL Interfacee04rlf (handle_​set_​nlnhess)

## 1Purpose

e04rlf is a part of the NAG optimization modelling suite and defines the structure of the Hessians of the nonlinear objective and constraints, on assumption that they are present in the problem. Alternatively, it may be used to define the Hessian of the Lagrangian.

## 2Specification

Fortran Interface
 Subroutine e04rlf ( idf, nnzh,
 Integer, Intent (In) :: idf, nnzh, irowh(nnzh), icolh(nnzh) Integer, Intent (Inout) :: ifail Type (c_ptr), Intent (In) :: handle
C Header Interface
#include <nag.h>
 void e04rlf_ (void **handle, const Integer *idf, const Integer *nnzh, const Integer irowh[], const Integer icolh[], Integer *ifail)
The routine may be called by the names e04rlf or nagf_opt_handle_set_nlnhess.

## 3Description

After the initialization routine e04raf has been called and an objective function $f$ or nonlinear constraint function ${g}_{i}$ has been registered with e04rgf and e04rkf, e04rlf can be used to define the sparsity structure of the Hessians, $H$, of those functions (i.e., the second partial derivatives with respect to the decision variables) or a linear combination of them, called the Lagrangian.
• Defining ${\nabla }^{2}f\equiv \left(\begin{array}{cccc}\frac{{\partial }^{2}f}{{\partial }^{2}{x}_{1}}& \frac{{\partial }^{2}f}{\partial {x}_{2}\partial {x}_{1}}& \dots & \frac{{\partial }^{2}f}{\partial {x}_{n}\partial {x}_{1}}\\ \frac{{\partial }^{2}f}{\partial {x}_{1}\partial {x}_{2}}& \frac{{\partial }^{2}f}{{\partial }^{2}{x}_{2}}& \dots & \frac{{\partial }^{2}f}{\partial {x}_{n}\partial {x}_{2}}\\ ⋮& ⋮& \ddots & ⋮\\ \frac{{\partial }^{2}f}{\partial {x}_{1}\partial {x}_{n}}& \frac{{\partial }^{2}f}{\partial {x}_{2}\partial {x}_{n}}& \dots & \frac{{\partial }^{2}f}{{\partial }^{2}{x}_{n}}\end{array}\right)$;
• the Hessian of the Lagrangian function $\equiv \sigma {\nabla }^{2}f+\sum _{i=1}^{m}{\lambda }_{i}{\nabla }^{2}{g}_{i}$;
• the Hessian of the objective function $\equiv {\nabla }^{2}f$;
• the Hessian of the constraint functions $\equiv {\nabla }^{2}{g}_{i}$.
Each of the symmetric $n×n$ Hessian matrices will have its own sparsity structure, in general. These structures can be given in separate e04rlf calls, or merged together in the Lagrangian and given in one call.
The nonzero values of the Hessians at particular points in the decision variable space will be communicated to the NLP solver by user-supplied functions (e.g., hess for e04stf).
Some NLP solvers (e.g., e04stf) expect either all of the Hessians (for objective and nonlinear constraints) to be supplied or none and they will terminate with an error indicator if only some but not all of the Hessians have been introduced by e04rlf.
Some NLP solvers (e.g., e04stf, again) will automatically switch to using internal approximations for the Hessians if none have been introduced by e04rlf. This usually results in a slower convergence (more iterations to the solution) and might even result in no solution being attainable within the ordinary tolerances.
See Section 3.1 in the E04 Chapter Introduction for more details about the NAG optimization modelling suite.
None.

## 5Arguments

1: $\mathbf{handle}$Type (c_ptr) Input
On entry: the handle to the problem. It needs to be initialized by e04raf and must not be changed between calls to the NAG optimization modelling suite.
2: $\mathbf{idf}$Integer Input
On entry: specifies the quantities for which a sparsity structure is provided in nnzh, irowh and icolh.
${\mathbf{idf}}=-1$
The sparsity structure of the Hessian of the Lagrangian is provided.
${\mathbf{idf}}=0$
The sparsity structure of the Hessian of the objective function is provided.
${\mathbf{idf}}>0$
The sparsity structure of the Hessian of the idfth constraint function is provided.
The value of idf will also determine how an NLP solver will call the user-supplied subroutines that evaluate these nonzeros at particular points of the decision variable space, i.e., whether the solver will expect the nonzero values of the objective and constraint Hessians in separate calls or merged in the Lagrangian Hessian, in one call. See, for example, hess of e04stf.
Constraint: $-1\le {\mathbf{idf}}\le \mathit{ncnln}$.
Note: $\mathit{ncnln}$, the number of nonlinear constraints registered with the handle.
3: $\mathbf{nnzh}$Integer Input
On entry: the number of nonzero elements in the upper triangle of the matrix $H$.
Constraint: ${\mathbf{nnzh}}>0$.
4: $\mathbf{irowh}\left({\mathbf{nnzh}}\right)$Integer array Input
5: $\mathbf{icolh}\left({\mathbf{nnzh}}\right)$Integer array Input
On entry: arrays irowh and icolh store the nonzeros of the upper triangle of the matrix $H$ in coordinate storage (CS) format (see Section 2.1.1 in the F11 Chapter Introduction). irowh specifies one-based row indices, icolh specifies one-based column indices and specifies the values of the nonzero elements in such a way that ${h}_{ij}=\mathit{H}\left(l\right)$ where $i={\mathbf{irowh}}\left(l\right)$ and $j={\mathbf{icolh}}\left(\mathit{l}\right)$, for $\mathit{l}=1,2,\dots ,{\mathbf{nnzh}}$. No particular order is expected, but elements should not repeat.
Constraint: $1\le {\mathbf{irowh}}\left(\mathit{l}\right)\le {\mathbf{icolh}}\left(\mathit{l}\right)\le n$, for $\mathit{l}=1,2,\dots ,{\mathbf{nnzh}}$.
6: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, . If you are unfamiliar with this argument you should refer to Section 4 in the Introduction to the NAG Library FL Interface for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, the recommended value is $-1$. When the value 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).

## 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:
${\mathbf{ifail}}=1$
The supplied handle does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by e04raf or it has been corrupted.
${\mathbf{ifail}}=2$
Neither nonlinear objective nor nonlinear constraints are present. The structure of the Hessian cannot be defined.
No nonlinear objective has been defined, its Hessian cannot be set.
The problem cannot be modified in this phase any more, the solver has already been called.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{idf}}=〈\mathit{\text{value}}〉$.
The structure of the Hessian of nonlinear function linked to the given idf has already been defined.
The structure of the Hessian of the Lagrangian has already been defined.
The structure of the individual Hessians has already been defined, the Hessian of the Lagrangian cannot be defined.
${\mathbf{ifail}}=6$
On entry, ${\mathbf{nnzh}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{nnzh}}>0$.
${\mathbf{ifail}}=7$
On entry, ${\mathbf{idf}}=〈\mathit{\text{value}}〉$.
Constraint: $〈\mathit{\text{value}}〉\le {\mathbf{idf}}\le 〈\mathit{\text{value}}〉$.
${\mathbf{ifail}}=8$
On entry, $i=〈\mathit{\text{value}}〉$, ${\mathbf{icolh}}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$ and $n=〈\mathit{\text{value}}〉$.
Constraint: $1\le {\mathbf{icolh}}\left(\mathit{i}\right)\le n$.
On entry, $i=〈\mathit{\text{value}}〉$, ${\mathbf{irowh}}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$ and ${\mathbf{icolh}}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{irowh}}\left(\mathit{i}\right)\le {\mathbf{icolh}}\left(\mathit{i}\right)$ (elements within the upper triangle).
On entry, $i=〈\mathit{\text{value}}〉$, ${\mathbf{irowh}}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$ and $n=〈\mathit{\text{value}}〉$.
Constraint: $1\le {\mathbf{irowh}}\left(\mathit{i}\right)\le n$.
On entry, more than one element of structural matrix $H$ has row index $〈\mathit{\text{value}}〉$ and column index $〈\mathit{\text{value}}〉$.
Constraint: each element of structural matrix $H$ must have a unique row and column index.
${\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.

Not applicable.

## 8Parallelism and Performance

e04rlf is not threaded in any implementation.

None.

## 10Example

See Section 10 in e04stf.