source: trunk/Docs/moresamples.xml @ 113

Last change on this file since 113 was 113, checked in by rlh, 15 years ago

* empty log message *

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="moreexamples">
3<title>
4More Samples
5</title>
6<section >
7<title>CBC's Samples Directory</title>
8<para>
9The CBC distribution includes a number of <filename>.cpp</filename> sample files.
10Users are encouraged to use them as starting points for their own CBC projects.
11The files can be found in the <filename>&cbcsamplesdir;</filename> directory.
12For the latest information on compiling and running these samples, please see
13the file <filename>&cbcsamplesdir;INSTALL</filename>.  Most of them can be built
14by <programlisting>make DRIVER=name</programlisting> which produces an executable <filename>testit</filename>.  Below is a list of
15some of the most useful sample files with a short description for each file.
16</para>
17<table frame="none">
18  <title>Basic Samples</title>
19  <tgroup cols="2">
20    <thead>
21      <row>
22        <entry align="left" valign="bottom">
23        Source file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
24        </entry>
25        <entry align="left" valign="bottom">
26        Description
27        </entry>
28      </row>
29    </thead>
30    <tbody>
31      <row>
32        <entry align="left" valign="top">
33        &minimumcpp;
34        </entry>
35        <entry align="left" valign="top">
36        This is a CBC &quot;Hello, world&quot; program.  It reads a problem
37        in MPS file format, and solves the problem.
38        </entry>
39      </row>
40      <row>
41        <entry align="left" valign="top">
42        &sample2cpp;
43        </entry>
44        <entry align="left" valign="top">
45        This is designed to be a file that a user could modify to get a useful
46        driver program for his or her project.  In particular, it demonstrates
47        the use of Cgl's  preprocess functionality.
48        It uses <function>CbcBranchUser.cpp</function>,
49        <function>CbcCompareUser.cpp</function> and
50        <function>CbcHeuristicUser.cpp</function> 
51        with corresponding <function>*.hpp</function> files.
52        </entry>
53      </row>
54    </tbody>
55  </tgroup>
56</table>
57<table frame="none">
58  <title>Advanced Samples</title>
59  <tgroup cols="2">
60    <thead>
61      <row>
62        <entry align="left" valign="bottom">
63        Source file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
64        </entry>
65        <entry align="left" valign="bottom">
66        Description
67        </entry>
68      </row>
69    </thead>
70    <tbody>
71      <row>
72        <entry align="left" valign="top">
73        &crewcpp;
74        </entry>
75        <entry align="left" valign="top">
76        This sample shows the use of advanced branching and a use of priorities.
77        It uses <function>CbcCompareUser.cpp</function>
78        with corresponding <function>*.hpp</function> files.
79        </entry>
80      </row>
81      <row>
82        <entry align="left" valign="top">
83        &longthincpp;
84        </entry>
85        <entry align="left" valign="top">
86        This sample shows the advanced use of a solver.  It also has coding for
87        a greedy heuristic.
88        The solver is given in <function>CbcSolver2.hpp</function> and
89        <function>CbcSolver2.cpp</function>.
90        The heuristic is given in <function>CbcHeuristicGreedy.hpp</function> and
91        <function>CbcHeuristicGreedy.cpp</function>.
92        It uses <function>CbcBranchUser.cpp</function> and
93        <function>CbcCompareUser.cpp</function>
94        with corresponding <function>*.hpp</function> files.
95        </entry>
96      </row>
97      <row>
98        <entry align="left" valign="top">
99        &qmipcpp;
100        </entry>
101        <entry align="left" valign="top">
102        This solves a quadratic mip.  It is to show advanced use of a solver.
103        The solver is given in <function>ClpQuadInterface.hpp</function> and
104        <function>ClpQuadInterface.cpp</function>.
105        It uses <function>CbcBranchUser.cpp</function> and
106        <function>CbcCompareUser.cpp</function>
107        with corresponding <function>*.hpp</function> files.
108        </entry>
109      </row>
110      <row>
111        <entry align="left" valign="top">
112        &soscpp;
113        </entry>
114        <entry align="left" valign="top">
115        This artificially creates a Special Ordered set problem.
116        </entry>
117      </row>
118      <row>
119        <entry align="left" valign="top">
120        &lotsizecpp;
121        </entry>
122        <entry align="left" valign="top">
123        This artificially creates a lot sizing problem.
124        </entry>
125      </row>
126    </tbody>
127  </tgroup>
128</table>
129
130</section>
131</chapter>
Note: See TracBrowser for help on using the repository browser.