source: trunk/Docs/clpexe.xml @ 411

Last change on this file since 411 was 408, checked in by ddelanu, 16 years ago

Candidate for User Guide revision 0.3, which is to be the first world-wide release

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