# NAG FL Interfacee04rtf (handle_​set_​qconstr_​fac)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

e04rtf is a part of the NAG optimization modelling suite and defines a new, or edits an existing, quadratic objective function or constraint of the problem using a factor of the quadratic coefficient matrix.

## 2Specification

Fortran Interface
 Subroutine e04rtf ( s, nnzr, idxr, r, mf, nnzf, f, idqc,
 Integer, Intent (In) :: nnzr, idxr(nnzr), mf, nnzf, irowf(nnzf), icolf(nnzf) Integer, Intent (Inout) :: idqc, ifail Real (Kind=nag_wp), Intent (In) :: s, r(nnzr), f(nnzf) Type (c_ptr), Intent (In) :: handle
#include <nag.h>
 void e04rtf_ (void **handle, const double *s, const Integer *nnzr, const Integer idxr[], const double r[], const Integer *mf, const Integer *nnzf, const Integer irowf[], const Integer icolf[], const double f[], Integer *idqc, Integer *ifail)
The routine may be called by the names e04rtf or nagf_opt_handle_set_qconstr_fac.

## 3Description

After the handle has been initialized (e.g., e04raf has been called), e04rtf may be used to edit a model by adding or replacing a quadratic objective function or constraint of the form
 $12 xTFTFx + rTx$ (1)
and
 $12 xTFTFx + rTx + s≤0 ,$ (2)
respectively.
The matrix $F$ is a sparse $m×n$ matrix. It can be viewed as the factor of the symmetric matrix $Q={F}^{\mathrm{T}}F$ in a general quadratic function
 $12 xTQx + rTx + s .$ (3)
It is also acceptable if $F$ is a zero matrix, in which case the corresponding objective function or constraint becomes linear. If you have the full matrix $Q$ as input data, please call routine e04rsf instead. Note that it is possible to temporarily disable and enable individual constraints in the model by e04tcf and e04tbf, respectively. 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 (e.g., by e04raf) and must not be changed between calls to the NAG optimization modelling suite.
2: $\mathbf{s}$Real (Kind=nag_wp) Input
On entry: the constant term in quadratic constraint.
If ${\mathbf{idqc}}=-1$, s will not be referenced.
3: $\mathbf{nnzr}$Integer Input
On entry: the number of nonzero elements in the sparse vector $r$.
If ${\mathbf{nnzr}}=0$, $r$ is considered to be zero and the arrays idxr and r will not be referenced.
Constraint: ${\mathbf{nnzr}}\ge 0$.
4: $\mathbf{idxr}\left({\mathbf{nnzr}}\right)$Integer array Input
5: $\mathbf{r}\left({\mathbf{nnzr}}\right)$Real (Kind=nag_wp) array Input
On entry: the nonzero elements of the sparse vector $r$. ${\mathbf{idxr}}\left(i\right)$ must contain the index of ${\mathbf{r}}\left(\mathit{i}\right)$ in the vector, for $\mathit{i}=1,2,\dots ,{\mathbf{nnzr}}$. No particular order is expected, but elements should not repeat. Note that $n$ is the current number of variables in the problem.
Constraint: $1\le {\mathbf{idxr}}\left(\mathit{i}\right)\le n$, for $\mathit{i}=1,2,\dots ,{\mathbf{nnzr}}$.
6: $\mathbf{mf}$Integer Input
On entry: $m$, row dimension of matrix $F$.
Constraint: ${\mathbf{mf}}>0$.
7: $\mathbf{nnzf}$Integer Input
On entry: the number of nonzero elements in the matrix $F$.
If ${\mathbf{nnzf}}=0$, the matrix $F$ is considered to be zero, the objective function or constraint is linear and mf, irowf, icolf and f will not be referenced.
Constraint: ${\mathbf{nnzf}}\ge 0$.
8: $\mathbf{irowf}\left({\mathbf{nnzf}}\right)$Integer array Input
9: $\mathbf{icolf}\left({\mathbf{nnzf}}\right)$Integer array Input
10: $\mathbf{f}\left({\mathbf{nnzf}}\right)$Real (Kind=nag_wp) array Input
On entry: arrays irowf, icolf and f store the nonzeros of the matrix $F$ in coordinate storage (CS) format (see Section 2.1.1 in the F11 Chapter Introduction). irowf specifies one-based row indices, icolf specifies one-based column indices and f specifies the values of the nonzero elements in such a way that ${F}_{ij}={\mathbf{f}}\left(l\right)$ where $i={\mathbf{irowf}}\left(l\right)$, $j={\mathbf{icolf}}\left(\mathit{l}\right)$, for $\mathit{l}=1,2,\dots ,{\mathbf{nnzf}}$. No particular order is expected, but elements should not repeat.
Constraint: $1\le {\mathbf{irowf}}\left(\mathit{l}\right)\le {\mathbf{mf}}\text{, ​}1\le {\mathbf{icolf}}\left(\mathit{l}\right)\le n$, for $\mathit{l}=1,2,\dots ,{\mathbf{nnzf}}$.
11: $\mathbf{idqc}$Integer Input/Output
On entry:
${\mathbf{idqc}}=0$
A new quadratic constraint is created.
${\mathbf{idqc}}>0$
Specifies the index of an existing constraint to be replaced. i.e., replaces the idqcth constraint.
${\mathbf{idqc}}=-1$
A new quadratic objective is created and will replace any previously defined objective function.
Constraint: ${\mathbf{idqc}}\ge -1$.
On exit: if ${\mathbf{idqc}}=0$ on entry, then idqc is overwritten with the index of the new quadratic constraint. By definition, this is the number of quadratic constraints already defined plus one. Otherwise, idqc stays unchanged.
12: $\mathbf{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 $-\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).

## 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 properly initialized or it has been corrupted.
${\mathbf{ifail}}=2$
The problem cannot be modified right now, the solver is running.
${\mathbf{ifail}}=4$
On entry, ${\mathbf{idqc}}=⟨\mathit{\text{value}}⟩$.
The given idqc does not match with any quadratic constraint already defined.
${\mathbf{ifail}}=5$
On entry, ${\mathbf{idqc}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{idqc}}\ge -1$.
${\mathbf{ifail}}=6$
nnzr and nnzf cannot be zero at the same time.
On entry, ${\mathbf{mf}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{mf}}>0$.
On entry, ${\mathbf{nnzf}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{nnzf}}\ge 0$.
On entry, ${\mathbf{nnzr}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{nnzr}}\ge 0$.
${\mathbf{ifail}}=7$
On entry, $i=⟨\mathit{\text{value}}⟩$, ${\mathbf{idxr}}\left(i\right)=⟨\mathit{\text{value}}⟩$ and $n=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le {\mathbf{idxr}}\left(i\right)\le n$.
On entry, more than one element of idxr has index $⟨\mathit{\text{value}}⟩$.
Constraint: each element of idxr must have a unique index.
${\mathbf{ifail}}=8$
On entry, $i=⟨\mathit{\text{value}}⟩$, ${\mathbf{icolf}}\left(\mathit{i}\right)=⟨\mathit{\text{value}}⟩$ and $n=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le {\mathbf{icolf}}\left(\mathit{i}\right)\le n$.
On entry, $i=⟨\mathit{\text{value}}⟩$, ${\mathbf{irowf}}\left(\mathit{i}\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{mf}}=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le {\mathbf{irowf}}\left(\mathit{i}\right)\le {\mathbf{mf}}$.
On entry, more than one element of f has row index $⟨\mathit{\text{value}}⟩$ and column index $⟨\mathit{\text{value}}⟩$.
Constraint: each element of f must have a unique row and column index.
${\mathbf{ifail}}=-99$
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

e04rtf is not threaded in any implementation.

None.

## 10Example

This example demonstrates how to define and solve a convex quadratic programming problem where the quadratic term is defined by its factors.
We solve the following norm minimization problem:
 $minimize x∈R3 ‖Ax-b‖22 subject to eTx=1, lx ≤ x ≤ ux,$
where
 $A= ( 0.493 0.382 0.0 0.0 0.270 0.475 ) , b= ( 0.2 0.4 ),$
 $lx= ( -1.0 -1.0 -1.0 ) , ux= ( 1.0 1.0 1.0 ),$
and $e\in {R}^{3}$ is vector of all ones. Note that
 $‖Ax-b‖22 = xTATAx - 2bTAx + bTb$
which is a convex quadratic function.
The optimal solution (to five significant figures) is
 $x*=(1.0000,-0.97221,0.97221)T,$
and the objective function value without the constant term ${b}^{\mathrm{T}}b$ is $0.13130$.

### 10.1Program Text

Program Text (e04rtfe.f90)

### 10.2Program Data

Program Data (e04rtfe.d)

### 10.3Program Results

Program Results (e04rtfe.r)