File: readmps.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (370 lines) | stat: -rw-r--r-- 13,093 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) XXXX-2008 - INRIA
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="readmps">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>readmps</refname>
    <refpurpose> reads a file in MPS format</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>mps= readmps (file-name,bounds [,maxsizes]);</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>file-name</term>
        <listitem>
          <para>
            a string, the name of the mps file
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>bounds</term>
        <listitem>
          <para>
            2-vector
            <literal>[lowbound,upbound]</literal> , default lower and upper bounds
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>maxsizes</term>
        <listitem>
          <para>
            3-vector <literal>[maxm,maxn,maxnza]</literal>
            Maximum number of contraints and variables, maximum number of
            nonzeros entries in the LP constraint matrix. If omitted readmps
            reads the file once just to compute these numbers.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>mps</term>
        <listitem>
          <para>tlist with following fields</para>
          <variablelist>
            <varlistentry>
              <term>irobj</term>
              <listitem>
                <para>integer (index of the objective row).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>namec</term>
              <listitem>
                <para>character string (Name of the objective).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>nameb</term>
              <listitem>
                <para>character string (Name of the right hand side).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>namran</term>
              <listitem>
                <para>character string (Name of the ranges section).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>nambnd</term>
              <listitem>
                <para>character string (Name of the bounds section).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>name</term>
              <listitem>
                <para>character string (Name of the  LP problem).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>rownames</term>
              <listitem>
                <para>
                  character string column vector (Name of the rows).
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>colnames</term>
              <listitem>
                <para>
                   character string row vector (Name of the columns).
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>rowstat</term>
              <listitem>
                <para>integer vector,  row types:</para>
                <variablelist>
                  <varlistentry>
                    <term>1</term>
                    <listitem>
                      <para>row type is "="</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>2</term>
                    <listitem>
                      <para> row type is "&gt;="</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>3</term>
                    <listitem>
                      <para> row type is "&lt;="</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>4</term>
                    <listitem>
                      <para> objective row</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>5</term>
                    <listitem>
                      <para> other free row</para>
                    </listitem>
                  </varlistentry>
                </variablelist>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>rowcode</term>
              <listitem>
                <para>
                  real matrix <literal>[hdrowcd,lnkrow]</literal> with
                </para>
                <variablelist>
                  <varlistentry>
                    <term>hdrowcd</term>
                    <listitem>
                      <para>real vector (Header to the linked list of rows with the same codes).</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>lnkrow</term>
                    <listitem>
                      <para>integer vector (Linked list of rows with the same codes).</para>
                    </listitem>
                  </varlistentry>
                </variablelist>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>colcode</term>
              <listitem>
                <para>
                  real matrix <literal>[hdcolcd,lnkcol]</literal> with
                </para>
                <variablelist>
                  <varlistentry>
                    <term>hdcolcd</term>
                    <listitem>
                      <para>integer vector (Header to the linked list of columns with the same codes).</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>lnkcol</term>
                    <listitem>
                      <para>integer vector (Linked list of columns with the same codes).</para>
                    </listitem>
                  </varlistentry>
                </variablelist>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>rownmbs</term>
              <listitem>
                <para>integer vector (Row numbers of nonzeros in columns of matrix A.)</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>colpnts</term>
              <listitem>
                <para>integer vector (Pointers to the beginning of columns of matrix A).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>acoeff</term>
              <listitem>
                <para>real vector (Array of nonzero elements for each column).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>rhs</term>
              <listitem>
                <para>real vector ( Right hand side of the linear program).</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>ranges</term>
              <listitem>
                <para>real vector of constraint ranges.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>bounds</term>
              <listitem>
                <para>
                  real matrix <literal>[lbounds,ubounds]</literal> with
                </para>
                <variablelist>
                  <varlistentry>
                    <term>ubounds</term>
                    <listitem>
                      <para>full column vector of upper bounds</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>lbounds</term>
                    <listitem>
                      <para>full column vector of lower bounds</para>
                    </listitem>
                  </varlistentry>
                </variablelist>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>stavar</term>
              <listitem>
                <para>full column vector of variable status</para>
                <variablelist>
                  <varlistentry>
                    <term>0</term>
                    <listitem>
                      <para>standard (non negative) variable</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>1</term>
                    <listitem>
                      <para>upper bounded variable</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>2</term>
                    <listitem>
                      <para>lower bounded variable</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>3</term>
                    <listitem>
                      <para>lower and upper bounded variable</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>4</term>
                    <listitem>
                      <para>minus infinity type variable  i.e -inf&lt;x&lt;=u</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>5</term>
                    <listitem>
                      <para>plus infinity type variable  i.e l&lt;=x&lt; inf</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>6</term>
                    <listitem>
                      <para>fixed type variable  i.e l=x=u</para>
                    </listitem>
                  </varlistentry>
                  <varlistentry>
                    <term>-k</term>
                    <listitem>
                      <para>free variable</para>
                    </listitem>
                  </varlistentry>
                </variablelist>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>
      Reads a file containing description of an LP problem
      given  in MPS format and returns a <literal>tlist</literal>
      which describes the problem. It is an
      interface with the program <literal>rdmps1.f</literal> of hopdm (J. Gondzio).
      For a description of the variables, see the file rdmps1.f.
    </para>
    <para>
      MPS format is a standard ASCII medium for LP codes.
      MPS format is described in more detail in Murtagh's book:
    </para>
    <para>
      Murtagh B. (1981). Advanced Linear Programming, McGrew-Hill,
      New York, 1981.
    </para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example">
      <![CDATA[ 
//Let the LP problem:
//objective:
//   min     XONE + 4 YTWO + 9 ZTHREE
//constraints:
//  LIM1:    XONE +   YTWO            < = 5
//  LIM2:    XONE +            ZTHREE > = 10
// MYEQN:         -   YTWO  +  ZTHREE   = 7
//Bounds
//  0 < = XONE < = 4
// -1 < = YTWO < = 1

//Generate MPS file 
txt=['NAME          TESTPROB'
     'ROWS'
     ' N  COST'
     ' L  LIM1'
     ' G  LIM2'
     ' E  MYEQN'
     'COLUMNS'
     '    XONE      COST                 1   LIM1                 1'
     '    XONE      LIM2                 1'
     '    YTWO      COST                 4   LIM1                 1'
     '    YTWO      MYEQN               -1'
     '    ZTHREE    COST                 9   LIM2                 1'
     '    ZTHREE    MYEQN                1'
     'RHS'
     '    RHS1      LIM1                 5   LIM2                10'
     '    RHS1      MYEQN                7'
     'BOUNDS'
     ' UP BND1      XONE                 4'
     ' LO BND1      YTWO                -1'
     ' UP BND1      YTWO                 1'
     'ENDATA'];
mputl(txt,TMPDIR+'/test.mps')
//Read the MPS file
P=readmps(TMPDIR+'/test.mps',[0 10^30])
disp(P)
 ]]>
    </programlisting>
  </refsection>
</refentry>