NAG FL Interface
e04rff (handle_​set_​quadobj)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

e04rff is a part of the NAG optimization modelling suite and defines or redefines the objective function of the problem to be linear or quadratic.

2 Specification

Fortran Interface
Subroutine e04rff ( handle, nnzc, idxc, c, nnzh, irowh, icolh, h, ifail)
Integer, Intent (In) :: nnzc, idxc(nnzc), nnzh, irowh(nnzh), icolh(nnzh)
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (In) :: c(nnzc), h(nnzh)
Type (c_ptr), Intent (In) :: handle
C Header Interface
#include <nag.h>
void  e04rff_ (void **handle, const Integer *nnzc, const Integer idxc[], const double c[], const Integer *nnzh, const Integer irowh[], const Integer icolh[], const double h[], Integer *ifail)
The routine may be called by the names e04rff or nagf_opt_handle_set_quadobj.

3 Description

After the handle has been initialized (e.g., e04raf has been called), e04rff may be used to define the objective function of the problem as a quadratic function cTx+12xTHx or a sparse linear function cTx. If the objective function has already been defined, it will be overwritten. If e04rff is called with no nonzeroes in either c or H, any existing objective function is removed, no new one is added and the problem will be solved as a feasible point problem. e04tef may be used to set individual elements ci of the linear objective.
This objective function will typically be used for
Linear Programming (LP)
minimize xn cTx   (a) subject to   lBBxuB,   (b) lxxux ,   (c) (1)
Quadratic Programming problems (QP)
minimize xn 12 xTHx + cTx   (a) subject to lBBxuB,   (b) lxxux,   (c) (2)
or for Semidefinite Programming problems with bilinear matrix inequalities (BMI-SDP)
minimize xn 12 xTHx + cTx   (a) subject to   i,j=1 n xi xj Qijk + i=1 n xi Aik - A0k 0 ,  k=1,,mA ,   (b) lBBxuB,   (c) lxxux.   (d) (3)
The matrix H is a sparse symmetric n×n matrix. It does not need to be positive definite. See Section 3.1 in the E04 Chapter Introduction for more details about the NAG optimization modelling suite.

4 References


5 Arguments

1: handle Type (c_ptr) Input
On entry: the handle to the problem. It needs to be initialized (e.g., by e04raf) and must not be changed between calls to the NAG optimization modelling suite.
2: nnzc Integer Input
On entry: the number of nonzero elements in the sparse vector c.
If nnzc=0, c is considered to be zero and the arrays idxc and c will not be referenced.
Constraint: nnzc0.
3: idxc(nnzc) Integer array Input
4: c(nnzc) Real (Kind=nag_wp) array Input
On entry: the nonzero elements of the sparse vector c. idxc(i) must contain the index of c(i) in the vector, for i=1,2,,nnzc. The elements must be stored in ascending order. Note that n is the current number of variables in the model.
  • 1idxc(i)n, for i=1,2,,nnzc;
  • idxc(i)<idxc(i+1), for i=1,2,,nnzc-1.
5: nnzh Integer Input
On entry: the number of nonzero elements in the upper triangle of the matrix H.
If nnzh=0, the matrix H is considered to be zero, the objective function is linear and irowh, icolh and h will not be referenced.
Constraint: nnzh0.
6: irowh(nnzh) Integer array Input
7: icolh(nnzh) Integer array Input
8: h(nnzh) Real (Kind=nag_wp) array Input
On entry: arrays irowh, icolh and h 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 h specifies the values of the nonzero elements in such a way that hij=h(l) where i=irowh(l), j=icolh(l), for l=1,2,,nnzh. No particular order is expected, but elements should not repeat.
Constraint: 1irowh(l)icolh(l)n, for l=1,2,,nnzh.
9: ifail Integer Input/Output
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. 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:
The supplied handle does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been properly initialized or it has been corrupted.
The problem cannot be modified right now, the solver is running.
On entry, nnzc=value.
Constraint: nnzc0.
On entry, nnzh=value.
Constraint: nnzh0.
On entry, i=value, idxc(i)=value and idxc(i+1)=value.
Constraint: idxc(i)<idxc(i+1) (ascending order).
On entry, i=value, idxc(i)=value and n=value.
Constraint: 1idxc(i)n.
On entry, i=value, icolh(i)=value and n=value.
Constraint: 1icolh(i)n.
On entry, i=value, irowh(i)=value and icolh(i)=value.
Constraint: irowh(i)icolh(i) (elements within the upper triangle).
On entry, i=value, irowh(i)=value and n=value.
Constraint: 1irowh(i)n.
On entry, more than one element of h has row index value and column index value.
Constraint: each element of h must have a unique row and column index.
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.
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.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
e04rff is not threaded in any implementation.

9 Further Comments

9.1 Internal Changes

Internal changes have been made to this routine as follows:
For details of all known issues which have been reported for the NAG Library please refer to the Known Issues.

10 Example

This example demonstrates how to use nonlinear semidefinite programming to find a nearest correlation matrix satisfying additional requirements. This is a viable alternative to routines g02aaf, g02abf, g02ajf or g02anf as it easily allows you to add further constraints on the correlation matrix. In this case a problem with a linear matrix inequality and a quadratic objective function is formulated to find the nearest correlation matrix in the Frobenius norm preserving the nonzero pattern of the original input matrix. However, additional box bounds (e04rhf) or linear constraints (e04rjf) can be readily added to further bind individual elements of the new correlation matrix or new matrix inequalities (e04rnf) to restrict its eigenvalues.
The problem is as follows (to simplify the notation only the upper triangular parts are shown). To a given m×m symmetric input matrix G
G = ( g11 g1m gmm )  
find correction terms x1,,xn which form symmetric matrix G¯
G¯ = ( g¯11 g¯12 g¯1m g¯22 g¯2m g¯mm ) = ( 1 g12+x1 g13+x2 g1m+xi 1 g23+x3 1 1 gm-1m+xn 1 )  
so that the following requirements are met:
  1. (a)It is a correlation matrix, i.e., symmetric positive semidefinite matrix with a unit diagonal. This is achieved by the way G¯ is assembled and by a linear matrix inequality
    G¯ = x1 ( 0 1 0 0 0 0 0 0 0 0 ) + x2 ( 0 0 1 0 0 0 0 0 0 0 ) + x3 ( 0 0 0 0 0 1 0 0 0 0 ) + + xn ( 0 0 0 0 0 0 0 0 1 0 ) - ( −1 -g12 -g13 -g1m −1 -g23 -g2m −1 -g3m −1 ) 0 .  
  2. (b)G¯ is nearest to G in the Frobenius norm, i.e., it minimizes the Frobenius norm of the difference which is equivalent to:
    minimize ​12 ij ( g¯ ij -gij) 2 = i=1 n xi2 .  
  3. (c)G¯ preserves the nonzero structure of G. This is met by defining xi only for nonzero elements gij.
For the input matrix
G = ( 2 −1 0 0 −1 2 −1 0 0 −1 2 −1 0 0 −1 2 )  
the result is
G¯ = ( 1.0000 -0.6823 0.0000 0.0000 -0.6823 1.0000 -0.5344 0.0000 0.0000 -0.5344 1.0000 -0.6823 0.0000 0.0000 -0.6823 1.0000 ) .  
See also e04raf for links to further examples in the suite.

10.1 Program Text

Program Text (e04rffe.f90)

10.2 Program Data

Program Data (e04rffe.d)

10.3 Program Results

Program Results (e04rffe.r)