NAG FL Interface
e04rbf (handle_​set_​group)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

e04rbf is a part of the NAG optimization modelling suite and modifies a model by either adding a new, or replacing, or deleting an existing quadratic or rotated quadratic cone constraint.

2 Specification

Fortran Interface
Subroutine e04rbf ( handle, gtype, lgroup, group, idgroup, ifail)
Integer, Intent (In) :: lgroup, group(lgroup)
Integer, Intent (Inout) :: idgroup, ifail
Character (*), Intent (In) :: gtype
Type (c_ptr), Intent (In) :: handle
C Header Interface
#include <nag.h>
void  e04rbf_ (void **handle, const char *gtype, const Integer *lgroup, const Integer group[], Integer *idgroup, Integer *ifail, const Charlen length_gtype)
The routine may be called by the names e04rbf or nagf_opt_handle_set_group.

3 Description

After the handle has been initialized (e.g., e04raf has been called), e04rbf may be used to edit a model by adding, replacing, or deleting a cone constraint i of dimension mi. The supported cones are quadratic cone and rotated quadratic cone, also known as second-order cones, which are defined as follows:
The cone constraint is defined by its type and a subset (group) of variables. Let index set Gi{1,2,,n} denote variable indices, then xGi will denote the subvector of variables xn.
For example, if mi=3 and Gi={4,1,2}, then a quadratic cone constraint
xGi = (x4,x1,x2) Kq3  
implies the inequality constraints
x42 x12 + x22 ,   x4 0 .  
Typically, this routine will be used to build Second-order Cone Programming (SOCP) problems which might be formulated in the following way:
minimize xn cTx   (a) subject to lBBxuB,   (b) lxxux ,   (c) xGiKmi,i=1,,r,   (d) (3)
where Kmi is either a quadratic cone or a rotated quadratic cone of dimension mi.
e04rbf can be called repeatedly to add, replace or delete one cone constraint at a time. Note that it is also possible to temporarily disable and enable individual cone constraints in the model by calling e04tcf and e04tbf, respectively. 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: gtype Character(*) Input
On entry: the type of the cone constraint. gtype is case insensitive.
gtype='QUAD' or 'Q'
The group defines a quadratic cone.
gtype='RQUAD' or 'R'
The group defines a rotated quadratic cone.
Constraint: gtype='QUAD', 'Q', 'RQUAD' or 'R'.
3: lgroup Integer Input
On entry: mi, the number of variables in the group.
If lgroup=0, gtype and group will not be referenced, and the constraint with ID number idgroup will be deleted from the model.
  • if gtype='QUAD' or 'Q', lgroup=0 or lgroup2;
  • if gtype='RQUAD' or 'R', lgroup=0 or lgroup3.
4: group(lgroup) Integer array Input
On entry: Gi, the indices of the variables in the constraint. If lgroup=0, group is not referenced.
Constraint: 1group(k)n, for k=1,2,,lgroup , where n is the number of decision variables in the problem. The elements must not repeat.
5: idgroup Integer Input/Output
On entry:
A new cone constraint is created.
i, the ID number of the existing constraint to be deleted or replaced.
Constraint: idgroup0.
On exit: if idgroup=0 on entry, the ID number of the new cone constraint is returned. By definition, this is the number of cone constraints already defined plus one. Otherwise, idgroup remains unchanged.
6: 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, idgroup=value.
The given idgroup does not match with any cone constraint already defined.
On entry, gtype=value and lgroup=value.
Constraint: if gtype='QUAD' or 'Q', lgroup=0 or lgroup2.
On entry, gtype=value and lgroup=value.
Constraint: if gtype='RQUAD' or 'R', lgroup=0 or lgroup3.
On entry, lgroup=value.
Constraint: lgroup0.
On entry, gtype=value.
Constraint: gtype='QUAD', 'Q', 'RQUAD' or 'R'.
On entry, idgroup=value.
Constraint: idgroup0.
On entry, k=value, group(k)=value and n=value.
Constraint: 1group(k)n.
On entry, group(i)=group(j)=value for i=value and j=value.
Constraint: elements in group cannot repeat.
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.
e04rbf 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

See e04ptf.