source: branches/gh-pages/ @ 2521

Last change on this file since 2521 was 2521, checked in by stefan, 2 months ago

migrate Cbc documentation to gh-pages

  • converted docbook to markdown
  • source now in gh-pages branch, so remove Cbc/doc
  • some cleanup
  • update link in
  • Property svn:eol-style set to native
File size: 4.0 KB
1# CBC's Samples Directory
3The CBC distribution includes a number of `.cpp` sample files. Users are
4encouraged to use them as starting points for their own CBC projects.
5The files can be found in the `Cbc/examples` directory. Most of them can be built by
7    make DRIVER=name
9which produces an executable `testit`. Below is a list of some of the
10most useful sample files with a short description for each file.
12Basic Samples:
14| Source file | Description                                                                                                                                                                                                                                                                                            |
15| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
16| MINIMUMCPP  | This is a CBC "Hello, world" program. It reads a problem in MPS file format, and solves the problem using simple branch-and-bound.                                                                                                                                                                     |
17| SAMPLE2CPP  | This is designed to be a file that a user could modify to get a useful driver program for his or her project. In particular, it demonstrates the use of CGL's preprocess functionality. It uses `CbcBranchUser.cpp`, `CbcCompareUser.cpp` and `CbcHeuristicUser.cpp` with corresponding `*.hpp` files. |
19Advanced Samples:
21| Source file | Description                                                                                                                                                                                                                                                                                                                      |
22| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23| CREWCPP     | This sample shows the use of advanced branching and a use of priorities. It uses `CbcCompareUser.cpp` with corresponding `*.hpp` files.                                                                                                                                                                                          |
24| LONGTHINCPP | This sample shows the advanced use of a solver. It also has coding for a greedy heuristic. The solver is given in `CbcSolver2.hpp` and `CbcSolver2.cpp`. The heuristic is given in `CbcHeuristicGreedy.hpp` and `CbcHeuristicGreedy.cpp`. It uses `CbcBranchUser.cpp` and `CbcCompareUser.cpp` with corresponding `*.hpp` files. |
25| QMIPCPP     | This solves a quadratic MIP. It is to show advanced use of a solver. The solver is given in `ClpQuadInterface.hpp` and `ClpQuadInterface.cpp`. It uses `CbcBranchUser.cpp` and `CbcCompareUser.cpp` with corresponding `*.hpp` files.                                                                                            |
26| SOSCPP      | This artificially creates a Special Ordered Set problem.                                                                                                                                                                                                                                                                         |
27| LOTSIZECPP  | This artificially creates a Lot Sizing problem.                                                                                                                                                                                                                                                                                  |
Note: See TracBrowser for help on using the repository browser.