NAG CL Interface
e04rbc (handle_set_group)
1
Purpose
e04rbc 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
The function may be called by the names: e04rbc or nag_opt_handle_set_group.
3
Description
After the initialization function
e04rac has been called,
e04rbc may be used to edit a model by adding, replacing, or deleting a cone constraint
of dimension
. The supported cones are quadratic cone and rotated quadratic cone, also known as second-order cones, which are defined as follows:
-
•Quadratic cone:
-
•Rotated quadratic cone:
The cone constraint is defined by its type and a subset (group) of variables. Let index set denote variable indices, then will denote the subvector of variables .
For example, if
and
, then a quadratic cone constraint
implies the inequality constraints
Typically, this function will be used to build second-order cone programming (SOCP) problems which might be formulated in the following way:
where
is either quadratic cone or rotated quadratic cone of dimension
.
e04rbc can be called repeatedly to add, replace or delete one cone constraint at a time. See
Section 4.1 in the
E04 Chapter Introduction for more details about the NAG optimization modelling suite.
4
References
None.
5
Arguments
-
1:
– void *
Input
-
On entry: the handle to the problem. It needs to be initialized by
e04rac and
must not be changed between calls to the NAG optimization modelling suite.
-
2:
– const char *
Input
-
On entry: the type of the cone constraint, case insensitive.
- or
- The group defines a quadratic cone.
- or
- The group defines a rotated quadratic cone.
Constraint:
, , or .
-
3:
– Integer
Input
-
On entry:
, the number of the variables in the group.
If
,
gtype and
group will not be referenced and may be
NULL, and the constraint with ID number
idgroup will be deleted from the model.
Constraints:
- if or , or ;
- if or , or .
-
4:
– const Integer
Input
-
On entry:
, the indices of the variables in the constraint. If
,
group is not referenced and may be
NULL.
Constraint:
, for
, where
is the number of decision variables in the problem. The elements must not repeat and each variable can appear in one cone at most, see
Section 9.
-
5:
– Integer *
Input/Output
-
On entry:
- A new cone constraint is created.
- , the ID number of the existing constraint to be deleted or replaced.
Constraint:
.
On exit: if
on entry, the ID number of the new cone constraint is returned. By definition, this is the number of the cone constraints already defined plus one. Otherwise,
idgroup stays unchanged.
-
6:
– NagError *
Input/Output
-
The NAG error argument (see
Section 7 in the Introduction to the NAG Library CL Interface).
6
Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_HANDLE
-
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
e04rac or it has been corrupted.
- NE_INDICES
-
On entry, , and .
Constraint: .
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
See
Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 8 in the Introduction to the NAG Library CL Interface for further information.
- NE_PHASE
-
The problem cannot be modified in this phase any more, the solver has already been called.
- NE_REF_MATCH
-
On entry,
.
The given
idgroup does not match with any cone constraint already defined.
- NE_REPEAT_CONEVAR_DF
-
On entry, variable with index has been defined in a cone in a previous call to this function.
Constraint: each variable may be defined in one cone constraint at most.
- NE_REPEAT_CONEVAR_SM
-
On entry,
for
and
.
Constraint: elements in
group cannot repeat.
- NE_STANDARD_ERRORS
-
On entry, and .
Constraint: if or , or .
On entry, and .
Constraint: if or , or .
- NE_STR_UNKNOWN
-
On entry, .
Constraint: , , or .
7
Accuracy
Not applicable.
8
Parallelism and Performance
e04rbc is not threaded in any implementation.
Overlapping of cones is not supported, which means each variable may be defined in one cone at most. However by adding auxiliary variables, you can achieve the same effect. For example, if and , you can add one more variable and set , .
10
Example
This example solves the following SOCP problem
subject to the bounds
the general linear constraints
and the cone constraint
The optimal solution (to five significant figures) is
and the objective function value is
.
10.1
Program Text
10.2
Program Data
10.3
Program Results