e04mxc reads data for sparse linear programming, mixed integer linear programming, quadratic programming or mixed integer quadratic programming problems from an external file which is in standard or compatible MPS input format.
The function may be called by the names: e04mxc or nag_opt_miqp_mps_read.
3Description
e04mxc reads data for Linear Programming (LP) or Quadratic Programming (QP) problems (or their mixed integer variants) from an external file which is prepared in standard or compatible MPS (see IBM (1971)) input format. It then initializes (the number of variables), (the number of general linear constraints), the matrix , the vectors , , (stored in row iobj of ) and the Hessian matrix for use with
e04nqc.
This function is
designed to solve problems of the form
3.1MPS input format
The input file of data may only contain two types of lines:
1.Indicator lines (specifying the type of data which is to follow).
2.Data lines (specifying the actual data).
A section is a combination of an indicator line and its corresponding data line(s). Any characters beyond column 80 are ignored. Indicator lines must not contain leading blank characters (in other words they must begin in column 1). The following displays the order in which the indicator lines must appear in the file:
NAME
user-supplied name
(optional)
OBJSENSE
(optional)
data line
OBJNAME
(optional)
data line
ROWS
data line(s)
COLUMNS
data line(s)
RHS
data line(s)
RANGES
(optional)
data line(s)
BOUNDS
(optional)
data line(s)
QUADOBJ
(optional)
data line(s)
ENDATA
A data line follows a fixed format, being made up of fields as defined below. The contents of the fields may have different significance depending upon the section of data in which they appear.
Field 1
Field 2
Field 3
Field 4
Field 5
Field 6
Columns
Contents
Code
Name
Name
Value
Name
Value
Each name and code must consist of ‘printable’ characters only; names and codes supplied must match the case used in the following descriptions. Values are read using a field width of . This allows values to be entered in several equivalent forms. For example, , , and all represent the same number. It is safest to include an explicit decimal point.
Lines with an asterisk () in column will be considered comment lines and will be ignored by the function.
Columns outside the six fields must be blank, except for columns 72–80, whose contents are ignored by the function. A non-blank character outside the predefined six fields and columns 72–80 is considered to be a major error ( NE_MPS_ILLEGAL_DATA_LINE; see Section 6), unless it is part of a comment.
3.1.1NAME Section (optional)
The NAME section is the only section where the data must be on the same line as the indicator. The ‘user-supplied name’ must be in field but may be blank.
Field
Required
Description
No
Name of the problem
3.1.2OBJSENSE Section (optional)
The data line in this section can be used to specify the sense of the objective function. If this section is present it must contain only one data line. If the section is missing or empty, minimization is assumed.
Field
Required
Description
No
Sense of the objective function
Field 2 may contain either MIN, MAX, MINIMIZE or MAXIMIZE.
3.1.3OBJNAME Section (optional)
The data line in this section can be used to specify the name of a free row (see Section 3.1.4) that should be used as the objective function. If this section is present it must contain only one data line. If the section is missing or is empty, the first free row will be chosen instead. Alternatively, OBJNAME can be overridden by setting nonempty (see Section 5).
Field
Required
Description
No
Row name to be used as the objective function
Field 2 must contain a valid row name.
3.1.4ROWS Section
The data lines in this section specify unique row (constraint) names and their inequality types (i.e., unconstrained, , or ).
Field
Required
Description
Yes
Inequality key
Yes
Row name
The inequality key specifies each row's type. It must be E, G, L or N and can be in either column or .
Inequality Key
Description
N
Free row
G
Greater than or equal to
finite
L
Less than or equal to
finite
E
Equal to
finite
Row type N stands for ‘Not binding’. It can be used to define the objective row. The objective row is a free row that specifies the vector in the linear objective term . If there is more than one free row, the first free row is chosen, unless another free row name is specified by OBJNAME (see Section 3.1.3) or (see Section 5). Note that is assumed to be zero if either the chosen row does not appear in the COLUMNS section (i.e., has no nonzero elements) or there are no free rows defined in the ROWS section.
3.1.5COLUMNS Section
Data lines in this section specify the names to be assigned to the variables (columns) in the general linear constraint matrix , and define, in terms of column vectors, the actual values of the corresponding matrix elements.
Field
Required
Description
Yes
Column name
Yes
Row name
Yes
Value
No
Row name
No
Value
Each data line in the COLUMNS section defines the nonzero elements of or . Any elements of or that are undefined are assumed to be zero. Nonzero elements of must be grouped by column, that is to say that all of the nonzero elements in the jth column of must be specified before those in the th column, for . Rows may appear in any order within the column.
3.1.5.1Integer Markers
For backward compatibility e04mxc allows you to define the integer variables within the COLUMNS section using integer markers, although this is not recommended as markers can be treated differently by different MPS readers; you should instead define any integer variables in the BOUNDS section (see below). Each marker line must have the following format:
Field
Required
Description
No
Marker ID
Yes
Marker tag
Yes
Marker type
The marker tag must be 'MARKER'. The marker type must be 'INTORG' to start reading integer variables and 'INTEND' to finish reading integer variables. This implies that a row cannot be named 'MARKER', 'INTORG' or 'INTEND'. Please note that both marker tag and marker type comprise of characters as a ' is the mandatory first and last character in the string. You may wish to have several integer marker sections within the COLUMNS section, in which case each marker section must begin with an 'INTORG' marker and end with an 'INTEND' marker and there should not be another marker between them.
Field 2 is ignored by e04mxc. When an integer variable is declared it will keep its default bounds unless they are changed in the BOUNDS section. This may vary between different MPS readers.
3.1.6RHS Section
This section specifies the right-hand side values (if any) of the general linear constraint matrix .
Field
Required
Description
Yes
RHS name
Yes
Row name
Yes
Value
No
Row name
No
Value
The MPS file may contain several RHS sets distinguished by RHS name. If an RHS name is defined in (see Section 5) then e04mxc will read in only that RHS vector, otherwise the first RHS set will be used.
Only the nonzero RHS elements need to be specified. Note that if an RHS is given to the objective function it will be ignored by e04mxc. An RHS given to the objective function is dealt with differently by different MPS readers, therefore, it is safer to not define an RHS of the objective function in your MPS file. Note that this section may be empty, in which case the RHS vector is assumed to be zero.
3.1.7RANGES Section (optional)
Ranges are used to modify the interpretation of constraints defined in the ROWS section (see Section 3.1.4) to the form , where both and are finite. The range of the constraint is .
Field
Required
Description
Yes
Range name
Yes
Row name
Yes
Value
No
Row name
No
Value
The range of each constraint implies an upper and lower bound dependent on the inequality key of each constraint, on the RHS of the constraint (as defined in the RHS section), and on the range .
Inequality Key
Sign of
E
E
G
L
N
If a range name is defined in (see Section 5) then the function will read in only the range set of that name, otherwise the first set will be used.
3.1.8BOUNDS Section (optional)
These lines specify limits on the values of the variables (the quantities and in ). If a variable is not specified in the bound set then it is automatically assumed to lie between and .
Field
Required
Description
Yes
Bound type identifier
Yes
Bound name
Yes
Column name
Yes/No
Value
Note: field 4 is required only if the bound type identifier is one of UP, LO, FX, UI or LI in which case it gives the value below. If the bound type identifier is FR, MI, PL or BV, field 4 is ignored and it is recommended to leave it blank.
The table below describes the acceptable bound type identifiers and how each determines the variables' bounds.
Bound Type Identifier
Integer Variable?
UP
unchanged
No
LO
unchanged
No
FX
No
FR
No
MI
unchanged
No
PL
unchanged
No
BV
Yes
UI
unchanged
Yes
LI
unchanged
Yes
If a bound name is defined in (see Section 5) then the function will read in only the bound set of that name, otherwise the first set will be used.
3.1.9QUADOBJ Section (optional)
The QUADOBJ section defines nonzero elements of the upper or lower triangle of the Hessian matrix .
Field
Required
Description
Yes
Column name (HColumn Index)
Yes
Column name (HRow Index)
Yes
Value
No
Column name (HRow Index)
No
Value
Each data line in the QUADOBJ section defines one (or optionally two) nonzero elements of the matrix . Each element is given as a triplet of row index , column index and a value. The column names (as defined in the COLUMNS section) are used to link the names of the variables and the indices and . More precisely, the matrix on output will have a nonzero element
where index belongs to HColumn Index and index to one of the HRow Indices such that
and
.
It is only necessary to define either the upper or lower triangle of the matrix; either will suffice. Any elements that have been defined in the upper triangle of the matrix will be moved to the lower triangle of the matrix, then any repeated nonzeros will be summed.
Note: it is much more efficient for
e04nqc
to have the matrix defined by the first ncolh column names. If the nonzeros of are defined by any columns that are not in the first ncolh of n then e04mxc will rearrange the matrices and so that they are.
3.2Query Mode
e04mxc offers a ‘query mode’ to quickly give upper estimates on the sizes of user arrays. In this mode any expensive checks of the data and of the file format are skipped, providing a prompt count of the number of variables, constraints and matrix nonzeros. This might be useful in the common case where the size of the problem is not known in advance.
You may activate query mode by setting any of the following:
,
,
,
or
. If no major formatting error is detected in the data file, NE_NOERROR is returned and the upper estimates are given as stated in Table 1. Alternatively, the function switches to query mode while the file is being read if it is discovered that the provided space is insufficient (that is, if ,
,
,
,
or
). In this case NE_INT_MAX is returned.
IBM (1971) MPSX – Mathematical programming system Program Number 5734 XM4 IBM Trade Corporation, New York
5Arguments
1: – Nag_FileIDInput
On entry: the ID of the MPSX data file to be read as returned by a call to x04acc.
Constraint:
.
2: – IntegerInput
On entry: an upper limit for the number of variables in the problem.
If , e04mxc will start in query mode (see Section 3.2).
3: – IntegerInput
On entry: an upper limit for the number of general linear constraints (including the objective row) in the problem.
If , e04mxc will start in query mode (see Section 3.2).
4: – IntegerInput
On entry: an upper limit for the number of nonzeros (including the objective row) in the problem.
If , e04mxc will start in query mode (see Section 3.2).
5: – IntegerInput
On entry: an upper limit for the dimension of the matrix .
If , e04mxc will start in query mode (see Section 3.2).
6: – IntegerInput
On entry: an upper limit for the number of nonzeros of the matrix .
If , e04mxc will start in query mode (see Section 3.2).
7: – IntegerInput
On entry: if , an upper limit for the number of integer variables.
If , e04mxc will treat all integer variables in the file as continuous variables.
8: – IntegerInput
On entry: if , summary messages are sent to stdout as e04mxc reads through the data file. This can be useful for debugging the file. If , then no summary is produced.
9: – Integer *Output
On exit: if e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, an upper estimate of the number of variables of the problem. Otherwise, , the actual number of variables in the problem.
10: – Integer *Output
On exit: if e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, an upper estimate of the number of general linear constraints in the problem (including the objective row). Otherwise, , the actual number of general linear constraints of the problem.
11: – Integer *Output
On exit: if e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, an upper estimate of the number of nonzeros in the problem (including the objective row). Otherwise, the actual number of nonzeros in the problem (including the objective row).
12: – Integer *Output
On exit: if e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, an upper estimate of the value of ncolh required by e04nqc. In this context ncolh is the number of leading nonzero columns of the Hessian matrix . Otherwise, the actual dimension of the matrix .
13: – Integer *Output
On exit: if e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, an upper estimate of the number of nonzeros of the matrix . Otherwise, the actual number of nonzeros of the matrix .
14: – Integer *Output
On exit: if on entry , all integer variables are treated as continuous and .
If e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, an upper estimate of the number of integer variables of the problem. Otherwise, the actual number of integer variables of the problem.
15: – Integer *Output
On exit: if , row iobj of is a free row containing the nonzero coefficients of the vector .
If , the coefficients of are assumed to be zero.
If e04mxc is run in query mode (see Section 3.2) iobj is not referenced and may be NULL.
16: – doubleOutput
Note: the dimension, dim, of the array a
must be at least
maxnnz when .
On exit: the nonzero elements of , ordered by increasing column index.
If e04mxc is run in query mode (see Section 3.2), a is not referenced and may be NULL.
17: – IntegerOutput
Note: the dimension, dim, of the array irowa
must be at least
maxnnz when .
On exit: the row indices of the nonzero elements stored in a.
If e04mxc is run in query mode (see Section 3.2), irowa is not referenced and may be NULL.
18: – IntegerOutput
Note: the dimension, dim, of the array iccola
must be at least
when .
On exit: a set of pointers to the beginning of each column of . More precisely,
contains the index in a of the start of the th column, for . Note that and .
If e04mxc is run in query mode (see Section 3.2), iccola is not referenced and may be NULL.
19: – doubleOutput
20: – doubleOutput
Note: the dimension, dim, of the arrays bl and bu
must be at least
when and .
On exit: bl contains the vector (the lower bounds) and bu contains the vector (the upper bounds), for all the variables and constraints in the following order. The first n elements of each array contains the bounds on the variables and the next m elements contains the bounds for the linear objective term and for the general linear constraints (if any). Note that an ‘infinite’ lower bound is indicated by and an ‘infinite’ upper bound by . In other words, any element of greater than or equal to will be regarded as (and similarly any element of less than or equal to will be regarded as ). If this value is deemed to be ‘inappropriate’, before calling e04nqc you are recommended to reset the value of its optional parameter and make any necessary changes to bl and/or bu.
If e04mxc is run in query mode (see Section 3.2), bl and bu are not referenced and may be NULL.
21: – char Input/Output
On entry: a set of names associated with the MPSX form of the problem.
Must either contain the name of the problem or be blank.
Must either be blank or contain the name of the objective row (in which case it overrides the OBJNAME section and the default choice of the first objective free row).
Must either contain the name of the RHS set to be used or be blank (in which case the first RHS set is used).
Must either contain the name of the RANGE set to be used or be blank (in which case the first RANGE set (if any) is used).
Must either contain the name of the BOUNDS set to be used or be blank (in which case the first BOUNDS set (if any) is used).
On exit: a set of names associated with the problem as defined in the MPSX data file as follows:
Contains the name of the problem (or blank if none).
Contains the name of the objective row (or blank if none).
Contains the name of the RHS set (or blank if none).
Contains the name of the RANGE set (or blank if none).
Contains the name of the BOUNDS set (or blank if none).
If e04mxc is run in query mode (see Section 3.2), pnames is not referenced and may be NULL.
22: – Integer *Output
On exit: , the total number of variables and constraints in the problem (including the objective row).
If e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, nname is not set. In the former case you may pass NULL instead.
23: – char Output
Note: the dimension, dim, of the array crname
must be at least
when and .
On exit: the MPS names of all the variables and constraints in the problem in the following order. The first n elements contain the MPS names for the variables and the next m elements contain the MPS names for the objective row and general linear constraints (if any). Note that the MPS name for the objective row is stored in .
If e04mxc is run in query mode (see Section 3.2), crname is not referenced and may be NULL.
24: – doubleOutput
Note: the dimension, dim, of the array h
must be at least
maxnnzh when .
On exit: the nnzh nonzero elements of , arranged by increasing column index.
If e04mxc is run in query mode (see Section 3.2), h is not referenced and may be NULL.
25: – IntegerOutput
Note: the dimension, dim, of the array irowh
must be at least
maxnnzh when .
On exit: the nnzh row indices of the elements stored in .
If e04mxc is run in query mode (see Section 3.2), irowh is not referenced and may be NULL.
26: – IntegerOutput
Note: the dimension, dim, of the array iccolh
must be at least
when .
On exit: a set of pointers to the beginning of each column of . More precisely,
contains the index in of the start of the th column, for . Note that and .
If e04mxc is run in query mode (see Section 3.2), iccolh is not referenced and may be NULL.
27: – Integer *Output
On exit: minmax defines the direction of the optimization as read from the MPS file. By default the function assumes the objective function should be minimized and will return . If the function discovers in the OBJSENSE section that the objective function should be maximized it will return . If the function discovers that there is neither the linear objective term (the objective row) nor the Hessian matrix , the problem is considered as a feasible point problem and is returned.
If e04mxc was run in query mode (see Section 3.2), or returned with NE_INT_MAX, minmax is not set. In the former case you may pass NULL instead.
28: – IntegerOutput
Note: the dimension, dim, of the array intvar
must be at least
maxlintvar, when .
On exit: if on entry, intvar contains pointers to the columns that are defined as integer variables. More precisely,
, where is the index of a column that is defined as an integer variable, for .
If on entry, or e04mxc was run in query mode (see Section 3.2), or it returned with NE_INT_MAX, intvar is not set. Excepting the latter case you may pass NULL as this argument instead.
29: – NagError *Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).
Note that if any of the relevant arguments are accidentally set to zero, or not set and assume zero values, then the function will have executed in query mode. In this case only the size of the problem is returned and other arguments are not set. See Section 3.2.
6Error 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.
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_MPS_BOUNDS
Inconsistent bounds for column ‘’.
Inconsistent bounds for row ‘’.
The supplied name, in , of the BOUNDS set to be used was not found in the BOUNDS section.
Unknown bound type ‘’ in BOUNDS section.
Inconsistent bounds are reported when the lower bound is greater than or equal to or the upper bound is less than or equal to , or when the lower bound is greater than the upper bound.
NE_MPS_COLUMNS
Column ‘’ has been defined more than once in the COLUMNS section. Column definitions must be continuous. (See Section 3.1.5).
Unknown column name ‘’ in section.
All column names must be specified in the COLUMNS section.
NE_MPS_ENDATA_NOT_FOUND
End of file found before ENDATA indicator line.
NE_MPS_FORMAT
Warning: MPS file not strictly fixed format, although the problem was read anyway. The data may have been read incorrectly. You should set and repeat the call to e04mxc for more details.
NE_MPS_ILLEGAL_DATA_LINE
An illegal line was detected in ‘’ section.
This is neither a comment nor a valid data line.
Incorrect ordering of indicator lines.
BOUNDS indicator line found before COLUMNS indicator line.
Incorrect ordering of indicator lines.
COLUMNS indicator line found before ROWS indicator line.
Incorrect ordering of indicator lines.
OBJNAME indicator line found after ROWS indicator line.
Incorrect ordering of indicator lines.
QUADOBJ indicator line found before BOUNDS indicator line.
Incorrect ordering of indicator lines.
QUADOBJ indicator line found before COLUMNS indicator line.
Incorrect ordering of indicator lines.
RANGES indicator line found before RHS indicator line.
Incorrect ordering of indicator lines.
RHS indicator line found before COLUMNS indicator line.
Indicator line ‘’ has been found more than once in the MPS file.
No indicator line found in file. It may be an empty file.
Unknown indicator line ‘’.
NE_MPS_INVALID_INTORG_INTEND
Found 'INTEND' marker without previous marker being 'INTORG'.
Found 'INTORG' but not 'INTEND' before the end of the COLUMNS section.
Found 'INTORG' marker within 'INTORG' to 'INTEND' range.
Illegal marker type ‘’.
Should be either 'INTORG' or 'INTEND'.
NE_MPS_MANDATORY
At least one mandatory section not found in MPS file.
NE_MPS_OBJNAME
The supplied name, in or in OBJNAME, of the objective row was not found among the free rows in the ROWS section.
NE_MPS_PRINTABLE
Illegal column name.
Column names must consist of printable characters only.
Illegal row name.
Row names must consist of printable characters only.
NE_MPS_RANGES
The supplied name, in , of the RANGES set to be used was not found in the RANGES section.
NE_MPS_REPEAT_COLUMN
More than one nonzero of has row name ‘’ and column name ‘’ in the COLUMNS section.
NE_MPS_REPEAT_ROW
Row name ‘’ has been defined more than once in the ROWS section.
NE_MPS_RHS
The supplied name, in , of the RHS set to be used was not found in the RHS section.
NE_MPS_ROWS
Unknown inequality key ‘’ in ROWS section.
Expected ‘N’, ‘G’, ‘L’ or ‘E’.
Unknown row name ‘’ in section.
All row names must be specified in the ROWS section.
NE_MPS_ROWS_OR_CONS
Empty ROWS section.
Neither the objective row nor the constraints were defined.
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.
7Accuracy
Not applicable.
8Parallelism and Performance
Background information to multithreading can be found in the Multithreading documentation.
e04mxc makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.
9Further Comments
None.
10Example
This example solves the quadratic programming problem
where
The optimal solution (to five figures) is
Three bound constraints and two general linear constraints are active at the solution. Note that, although the Hessian matrix is only positive semidefinite, the point is unique.
The MPS representation of the problem is given in Section 10.2.
Another example which shows how to use e04mxc together with the NAG optimization modelling suite is associated with e04rjc.