source: trunk/Docs/clpexe.xml @ 417

Last change on this file since 417 was 417, checked in by ddelanu, 15 years ago

Fixed a typo

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="clpexe">
3  <title>
4  The CLP Executable
5  </title>
6  <para>
7  The result of <userinput>make unitTest</userinput> (executed in
8  <filename>COIN/Clp</filename>) is an executable
9  <filename>clp</filename> as well as the CLP and COIN libraries.
10  This can be used to do various unit tests, but can also be used as a standalone
11  solver.  As it only has a very simple solution file format the user may wish to
12  modify that part of <filename>COIN/Clp/Test/ClpMain.cpp</filename> and even
13  offer the modifications as contribution to CLP.
14  </para>
15  <para>
16  The <filename>clp</filename> executable operates in command line mode or
17  prompted mode.  Entering <userinput>clp</userinput> will bring being &quot;prompt
18  mode&quot;, while <userinput>clp &lt;filename&gt;</userinput> will import an MPS file
19  from filename and solve it using the dual simplex method and exit.  Again
20  <userinput>clp &lt;filename&gt; -primalsimplex</userinput> will import a file
21  and solve using the primal simplex method.  A dash
22  (&quot;<userinput>-</userinput>&quot;) by itself changes to prompt mode.  In
23  command line mode &quot;<userinput>-</userinput>&quot; is needed (apart from
24  first parameter which is taken as file name).  So the following are equivalent
25  and maximize a problem using dual and write a solution to file
26  <filename>solfile</filename>:
27  <blockquote>
28    <literallayout>
29    <prompt>$</prompt> <userinput>clp <replaceable>filename</replaceable> -maximize -dualsimplex -solution solfile</userinput>
30    </literallayout>
31  </blockquote>
32  <blockquote>
33    <literallayout>
34    <prompt>$</prompt> <userinput>clp <replaceable>filename</replaceable> -maximize -</userinput>
35    <prompt>Clp:</prompt><userinput>duals</userinput>
36    <prompt>Clp:</prompt><userinput>solution solfile</userinput>
37    <prompt>Clp:</prompt><userinput>quit</userinput>
38    </literallayout>
39  </blockquote>
40  </para>
41  <para>
42  The executable has some command-completion functionality as well as some inline
43  help.  Below is a table with some examples which summarize these capabilities.
44  </para>
45  <table frame="none">
46  <title>Command examples for the clp executable</title>
47  <tgroup cols="2">
48    <thead>
49      <row>
50        <entry align="left">
51        Command&nbsp;&nbsp;&nbsp;&nbsp;
52        </entry>
53        <entry align="left">
54        Result
55        </entry>
56      </row>
57    </thead>
58    <tbody>
59      <row>
60        <entry>
61        <command>?</command>
62        </entry>
63        <entry>
64        Gives a list of all  commands
65        </entry>
66      </row>
67      <row>
68        <entry>
69        <command>p?</command>
70        </entry>
71        <entry>
72        Gives a list of all commands which begin with &lt;p&gt;.
73        </entry>
74      </row>
75      <row>
76        <entry>
77        <command>p??</command>
78        </entry>
79        <entry>
80        Gives a list of all commands which begin with &lt;p&gt;., with a short
81        explanation for each.
82        </entry>
83      </row>
84      <row>
85        <entry>
86        <command>primals??</command>
87        </entry>
88        <entry>
89        If is this is enough to uniquely determine a command (in this example,
90        <command>primalS</command>, for primal simplex), a long explanation
91        is given.
92        </entry>
93      </row>
94    </tbody>
95  </tgroup>
96  </table>
97  <para>
98  In addition, matching a name without a ? will either execute the command or give
99  the value of the corresponding parameter.  So,
100  <command>primalweight</command> will give the current value of  the
101  primalWeight parameter while <command>primalw 1.0e7</command> will change
102  it to 1.0e7.
103  </para>
104  <para>
105  The executable is at a very early stage and comments will graciously
106  welcomed.
107  </para>
108</chapter>
Note: See TracBrowser for help on using the repository browser.