source: trunk/README.md @ 2366

Last change on this file since 2366 was 2326, checked in by tkr, 2 years ago

Fixing typo in README

File size: 10.3 KB
Line 
1# CBC Version 2.9.8 README
2
3Welcome to the README for the COIN Branch and Cut Solver (CBC). CBC is
4distributed under the Eclipse Public License and is freely redistributable.
5All source code and documentation is Copyright IBM and others. This README may
6be redistributed freely.
7
8## Current Testing Status
9
10[![Build Status](https://travis-ci.org/coin-or/Cbc.svg?branch=master)](https://travis-ci.org/coin-or/Cbc)
11
12[![Build status](https://ci.appveyor.com/api/projects/status/l2hwifsxwhswng8y/branch/master?svg=true)](https://ci.appveyor.com/project/tkralphs/cbc/branch/master)
13
14## DOWNLOAD
15
16[ ![Download](https://api.bintray.com/packages/coin-or/download/Cbc/images/download.svg) ](https://bintray.com/coin-or/download/Cbc/2.9)
17
18Binaries for most platforms are available for download from [Bintray](https://bintray.com/coin-or/download/Cbc)
19
20## DOCUMENTATION
21
22For a quick start guide, please see the INSTALL file in this distribution. A
23(somehwat outdated) user's manual is available here:
24
25http://www.coin-or.org/Cbc
26
27More up-to-date automatically generated documentation of the source code can
28be found here:
29
30http://www.coin-or.org/Doxygen/Cbc/
31
32Further information can be found here:
33
34http://projects.coin-or.org/Cbc
35
36## SUPPORT
37
38### List Serve
39
40CBC users should use the Cbc mailing list. To subscribe, go to
41http://list.coin-or.org/mailman/listinfo/cbc
42
43### Bug Reports
44
45Bug reports should be reported on the CBC development web site at
46
47https://projects.coin-or.org/Cbc/newticket
48
49## CHANGELOG
50
51 * Release 2.9.8
52
53   * Update to most current releases of dependencies
54   * Small bug fixes
55   * Add support for automatic build and test with Travis and Appveyor
56
57 * Release 2.9.7
58
59   * Small bug fixes
60   * Option to switch to line buffered output
61
62 * Release 2.9.6
63
64   * Small bug fixes
65
66 * Release 2.9.5
67
68   * Small bug fixes
69
70 * Release 2.9.4
71
72   * Small fixes for stability
73   * Fixes for Doygen documentation generation
74
75 * Release 2.9.3
76
77   * Minor bug fixes
78
79 * Release 2.9.2
80
81   * Fix for proper installation with ```DESTDIR```
82
83 * Release 2.9.1
84
85   * Fix for dependency linking
86   * Minor bug fixes
87
88 * Release 2.9.0
89
90   * Introduced specialized branching methods for dealing with "big Ms".
91   * Introduced new methods for dealing with symmetry (requires installation of [nauty](http://pallini.di.uniroma1.it/))
92   * Introduction of conflict cuts (off by default, turn on with `-constraint conflict`)
93
94 * Release 2.8.13
95
96   * Improved message handling
97   * Miscellaneous bug fixes.
98
99 * Release 2.8.12
100
101   * Update for dependencies.
102
103 * Release 2.8.11
104
105   * Major overhaul of C interface
106   * Fixes to SOS
107   * Miscellaneous bug fixes
108
109 * Release 2.8.10
110
111   * More changes related to thread safety.
112   * Fix bug in build system with Visual Studio compiler.
113   * Miscellaneous bug fixes.
114
115 * Release 2.8.9
116
117   * Attempt to make Cbc thread safe.
118   * Add parallel examples.
119   * Add CbcSolverUsefulInfo.
120   * Bug fixes.
121
122 * Release 2.8.8
123
124   * Added example to show how to use Cbc with installed libraries in MSVC++
125   * Fixed inconsistency in addition of libCbcSolver to dependencies in
126     {{{cbc_addlibs.txt}}}.
127
128 * Release 2.8.7
129
130   * Changed so that Doxygen builds LaTex
131   * Fixes for build system
132
133 * Release 2.8.6
134
135   * Added option to explicitly link dependencies to comply with packaging
136     requirements on Fedora and Debian, as well as allow building of MinGW
137     DLLs.
138
139 * Release 2.8.5
140
141   * Minor fixes to build system
142
143 * Release 2.8.4
144
145   * Small bug fixes
146   * Upgrades to build system
147
148 * Release 2.8.3:
149
150   * Fix for handling SOS.
151
152 * Release 2.8.2:
153
154   * Fixed recognition of Glpk source in main configure.
155   * Minor bug fixes in CoinUtils, Clp, and Cbc.
156
157 * Release 2.8.1:
158
159   * Minor bug fixes
160
161 * Release 2.8.0:
162
163   * Introduced new secondaryStatus 8 to indicate that solving stopped due to
164     an iteration limit.
165   * Solution pool is now accessible via the command line and the CbcMain*
166     interface.
167   * New mipstart option to read an initial feasible solution from a file.
168     Only values for discrete variables need to be provided.
169
170   * Added Proximity Search heuristic by Fischetti and Monaci (off by
171     default): The simplest way to switch it on using stand-alone version is
172     ```-proximity on```.
173
174     Proximity Search is the new "No-Neighborhood Search" 0-1 MIP refinement
175     heuristic recently proposed by Fischetti and Monaci (2012). The idea is
176     to define a sub-MIP without additional constraints but with a modified
177     objective function intended to attract the search in the proximity of the
178     incumbent. The approach works well for 0-1 MIPs whose solution landscape
179     is not too irregular (meaning the there is reasonable probability of
180     finding an improved solution by flipping a small number of binary
181     variables), in particular when it is applied to the first heuristic
182     solutions found at the root node.
183   
184   * An implementation of Zero-Half-Cuts by Alberto Caprara is now available.
185     By default, these cuts are off. To use add to your command line
186     -zerohalfCuts root (or other options) or just -zero. So far, they may
187     help only on a small subset of problems and may need some tuning.
188
189     The implementation of these cuts is described in G. Andreello, A.
190     Caprara, and M. Fischetti "Embedding Cuts in a Branch and Cut Framework:
191     a Computational Study with {0,1/2}-Cuts" INFORMS Journal on Computing
192     19(2), 229-238, 2007 http://dx.doi.org/10.1287/ijoc.1050.0162
193
194   * An alternative implementation of a reduce and split cut generator by
195     Giacomo Nannicini is now available. By default, these cuts are off. To
196     use add to your command line -reduce2AndSplitCuts root (or other
197     options).
198
199     The implementation of these cuts is described in G. Cornuejols and G.
200     Nannicini "Practical strategies for generating rank-1 split cuts in
201     mixed-integer linear programming" Mathematical Programming Computation
202     3(4), 281-318, 2011 http://dx.doi.org/10.1007/s12532-011-0028-6
203
204   * An alternative robust implementation of a Gomory cut generator by Giacomo
205     Nannicini is now available. By default, these cuts are off. To use add to
206     your command line -GMI root (or other options).
207
208     The implementation of these cuts is described in G. Cornuejols, F.
209     Margot, and G. Nannicini "On the safety of Gomory cut generators"
210     http://faculty.sutd.edu.sg/~nannicini/index.php?page=publications
211
212   * To encourage the use of some of the more exotic/expensive cut generators
213     a parameter -slowcutpasses has been added. The idea is that the code does
214     these cuts just a few times - less than the more usual cuts. The default
215     is 10. The cut generators identified by "may be slow" at present are just
216     Lift and project and ReduceAndSplit (both versions).
217   
218   * Allow initialization of random seed by user. Pseudo-random numbers are
219     used in Cbc and Clp. In Clp they are used to break ties in degenerate
220     problems, while in Cbc heuristics such as the Feasibility Pump use them
221     to decide whether to round up or down. So if a different pseudo-random
222     seed is given to Clp then you may get a different continuous optimum and
223     so different cuts and heuristic solutions. This can be switched on by
224     setting randomSeed for Clp and/or randomCbcSeed for Cbc. The special
225     value of 0 tells code to use time of day for initial seed.
226   
227   * Building on this idea, Andrea Lodi, Matteo Fischetti, Michele Monaci,
228     Domenico Salvagnin, Yuji Shinano, and Andrea Tramontani suggest that this
229     idea be improved by running at the root node with multiple copies of
230     solver, each with its own different seed and then passing in the
231     solutions and cuts so that the main solver has a richer set of solutions
232     and possibly stronger cuts. This is switched on by setting
233     -multipleRootPasses. These can also be done in parallel.
234 
235   * Few changes to presolve for special variables and badly scaled problems
236     (in CoinUtils).
237
238   * New option -extraVariables <number> which switches on a trivial
239    re-formulation that introduces extra integer variables to group together
240    variables with same cost.
241
242   * For some problems, cut generators and general branching work better if
243     the problem would be infeasible if the cost is too high. If the new
244     option -constraintFromCutoff is set, the objective function is added as a
245     constraint which rhs is set to the current cutoff value (objective value
246     of best known solution).
247
248 * Release 2.7.8:
249
250   * Change message when LP simplex iteration limit is hit from "Exiting on
251     maximum nodes" to "Exiting on maximum number of iterations"
252   * Fix for using overlapping SOS.
253   * Fixes in buildsystem.
254
255 * Release 2.7.7:
256
257   * Fix to report interruption on user event if SIGINT is received by
258     CbcSolver. model->status() should now be 5 if this event happened. Added
259     method CbcModel::sayEventHappened() to make cbc stop due to an 'user
260     event'.
261
262   * Other minor fixes.
263
264 * Release 2.7.6:
265
266   * Fixes to build system.
267
268   * Other minor fixes.
269
270 * Release 2.7.5:
271
272   * Fixes to get AMPL interface working again.
273
274   * More fixes to MSVC++ files.
275
276 * Release 2.7.4:
277
278   * Minor bugfixes.
279
280 * Release 2.7.3:
281
282   * Minor bugfixes.
283
284   * Fixes to MSVC++ files.
285
286 * Release 2.7.2:
287
288   * Allow row/column names for GMPL models.
289
290   * Added CbcModel::haveMultiThreadSupport() to indicate whether Cbc library
291     has been compiled with multithread support.
292
293   * Added CbcModel::waitingForMiniBranchAndBound() to indicate whether
294     sub-MIP heuristic is currently running.
295
296   * Cbc shell should work with readline if configured with
297     ```--enable-gnu-packages```.
298
299   * Support for compressed input files (.gz, .bz2) is now enabled by default.
300
301   * Fix problems with relative gap tolerance > 100% and further bugs.
302
303   * Fixes for MSVC++ Version 9 files.
304
305   * Minor fixes in buildsystem; update to BuildTools 0.7.1.
306
307 * Release 2.7.1:
308
309   * Fixes to MSVC++ files
310
311 * Release 2.7.0:
312
313   * License has been changed to the EPL.
314
315   * Support for MSVC++ version 10 added.
316
317   * Support for BuildTools version 0.7 to incorporate recent enhancements,
318     including proper library versioning in Linux, prohibiting installation of
319     private headers, etc.
320
321   * Updated externals to new stable versions of dependent projects.
322
323   * Improvements to heuristics.
324
325   * New options for cut generation.
326
327   * Improved reporting of results.
328
329   * Improvements to documentation.
330
331   * Minor bug fixes.
332
333
Note: See TracBrowser for help on using the repository browser.