| 1 |
# Welcome to the COIN Vol Project |
| 2 |
|
| 3 |
## Introduction |
| 4 |
|
| 5 |
Vol (Volume Algorithm) is an open-source implementation of a subgradient |
| 6 |
method that produces primal as well as dual solutions. The primal solution |
| 7 |
comes from estimating the volumes below the faces of the dual problem. This is |
| 8 |
an approximate method so the primal vector might have small infeasiblities |
| 9 |
that are negligible in many practical settings. The original subgradient |
| 10 |
algorithm produces only dual solutions. |
| 11 |
|
| 12 |
## Background/Download |
| 13 |
|
| 14 |
Vol is written in C++ and is released as open source code under the |
| 15 |
[Eclipse Public License](http://www.opensource.org/licenses/eclipse-1.0)(EPL). |
| 16 |
To get all of the dependencies and build the `Vol` package, do |
| 17 |
|
| 18 |
``` |
| 19 |
git clone https://github.com/coin-or/Vol |
| 20 |
Vol |
| 21 |
git clone https://github.com/coin-or-tools/BuildTools |
| 22 |
BuildTools/get.dependencies fetch |
| 23 |
BuildTools/get.dependencies build |
| 24 |
``` |
| 25 |
To test by building an application, do |
| 26 |
``` |
| 27 |
cd build/Vol/examples/VolUfl |
| 28 |
make |
| 29 |
./ufl |
| 30 |
``` |
| 31 |
|
| 32 |
## Included Projects |
| 33 |
|
| 34 |
If you download the Vol package, you get |
| 35 |
[these](https://github.com/coin-or/Vol/blob/master/Dependencies) |
| 36 |
additional projects. |
| 37 |
|
| 38 |
## Doxygen Documentation |
| 39 |
|
| 40 |
If you have `Doxygen` available, you can build the html documentation by typing |
| 41 |
``` |
| 42 |
make doxydoc |
| 43 |
``` |
| 44 |
in the `Vol` directory. Then open the file `coin-Vol/doxydoc/html/index.html` with a browser. |
| 45 |
Note that this creates the documentation for the `Vol` |
| 46 |
package as a whole. If you |
| 47 |
prefer to generate the documentation only for a subset |
| 48 |
of these projects, you can edit the file `Vol/doxydoc/doxygen.conf` to exclude directories |
| 49 |
(using the `EXCLUDE` variable, for example). |
| 50 |
|
| 51 |
If `Doxygen` is not available, you can use the link to the {{{Vol}}} html documentation listed below. |
| 52 |
|
| 53 |
## Documentation |
| 54 |
|
| 55 |
* [Overview of different directories](https://projects.coin-or.org/Vol/attachment/wiki/WikiStart/volDoc.pdf?format=raw) |
| 56 |
* [The Volume Algorithm: Producing Primal Solutions With a Subgradient Method](http://domino.watson.ibm.com/library/cyberdig.nsf/a3807c5b4823c53f85256561006324be/7a1b25774639540a852565be0070cfb5?OpenDocument) |
| 57 |
* [On Some Difficult Linear Programs Coming from Set Partitioning](http://domino.watson.ibm.com/library/cyberdig.nsf/a3807c5b4823c53f85256561006324be/53731ca97769f3838525672f0070dc2b?OpenDocument) |
| 58 |
* [Solving Large Scale Uncapacitated Facility Location Problems](http://domino.watson.ibm.com/library/cyberdig.nsf/a3807c5b4823c53f85256561006324be/08e1ac62bb877f9a852567b500500996?OpenDocument) |
| 59 |
* [Near-Optimal Solutions to Large Scale Facility Location Problems](http://domino.watson.ibm.com/library/cyberdig.nsf/a3807c5b4823c53f85256561006324be/215bca4e7e2406ec852568430076860c?OpenDocument) |
| 60 |
* [Solving Steiner Tree Problems in Graphs with Lagrangian Relaxation](http://domino.watson.ibm.com/library/cyberdig.nsf/a3807c5b4823c53f85256561006324be/4a61544906b57a6d8525696c0057f955?OpenDocument&Highlight=0,barahona) |
| 61 |
* [Vol html documentation](http://www.coin-or.org/Doxygen/Vol/hierarchy.html) |
| 62 |
* [COIN-OR Initiative](http://www.coin-or.org/) |