E04RLF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

E04RLF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy
    10  Example

1  Purpose

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.

2  Specification

SUBROUTINE E04RLF ( HANDLE, IDF, NNZH, IROWH, ICOLH, IFAIL)
INTEGER  IDF, NNZH, IROWH(NNZH), ICOLH(NNZH), IFAIL
TYPE (C_PTR)  HANDLE

3  Description

After the initialization routine E04RAF has been called and an objective function f or nonlinear constraint function gi 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.
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 by the user 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.

4  References

None.

5  Arguments

1:     HANDLE – TYPE (C_PTR)Input
On entry: the handle to the problem. It needs to be initialized by E04RAF and must not be changed.
2:     IDF – INTEGERInput
On entry: specifies the quantities for which a sparsity structure is provided in NNZH, IROWH and ICOLH.
IDF=-1
The sparsity structure of the Hessian of the Lagrangian is provided.
IDF=0
The sparsity structure of the Hessian of the objective function is provided.
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: -1IDFncnln.
Note: ncnln, the number of nonlinear constraints registered with the handle.
3:     NNZH – INTEGERInput
On entry: the number of nonzero elements in the upper triangle of the matrix H.
Constraint: NNZH>0.
4:     IROWHNNZH – INTEGER arrayInput
5:     ICOLHNNZH – INTEGER arrayInput
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 hij=Hl where i=IROWHl and j=ICOLHl, for l=1,2,,NNZH. No particular order is expected, but elements should not repeat.
Constraint: 1IROWHlICOLHln, for l=1,2,,NNZH.
6:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 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 -1​ or ​1 is used it is essential to test the value of IFAIL on exit.
On exit: IFAIL=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

If on entry 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:
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.
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.
IFAIL=3
On entry, IDF=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.
IFAIL=6
On entry, NNZH=value.
Constraint: NNZH>0.
IFAIL=7
On entry, IDF=value.
Constraint: valueIDFvalue.
IFAIL=8
On entry, i=value, ICOLHi=value and n=value.
Constraint: 1ICOLHin.
On entry, i=value, IROWHi=value and ICOLHi=value.
Constraint: IROWHiICOLHi (elements within the upper triangle).
On entry, i=value, IROWHi=value and n=value.
Constraint: 1IROWHin.
On entry, more than one element of structural matrix H has row index value and column index value.
Constraint: each element of structural matrix H must have a unique row and column index.
IFAIL=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7  Accuracy

Not applicable.

8  Parallelism and Performance

E04RLF is not threaded in any implementation.

9  Further Comments

9.1  Additional Licensor

Parts of the code for E04STF are distributed according to terms imposed by another licensor. Please refer to Library Licensors for further details.

10  Example

See Section 10 in E04STF.

E04RLF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

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