wiki:WikiStart

Welcome to the Vol home page

Note that these project web pages are based on Wiki, which allows users to modify the content to correct typos, add information, or share their experience and tips with other users. You are welcome to contribute to these project web pages. To edit these pages or submit a ticket you must first register and login.

Introduction

Vol (Volume Algorithm) is an open-source implementation of a subgradient method that produces primal as well as dual solutions. The primal solution comes from estimating the volumes below the faces of the dual problem. This is an approximate method so the primal vector might have small infeasiblities that are negligible in many practical settings. The original subgradient algorithm produces only dual solutions.


Background/Download

Vol is written in C++ and is released as open source code under the Eclipse Public License (EPL). It is available from the COIN-OR initiative.

You can obtain the Vol source code either via subversion or in form of nightly generated tarballs. The recommended method is to use subversion because it makes it easier to obtain updates. The following commands may be used to obtain and build Vol from the source code using subversion:

  1. svn co https://projects.coin-or.org/svn/Vol/stable/1.1 coin-Vol
  2. cd coin-Vol
  3. ./configure -C
  4. make
  5. make install
  6. go to the directory Vol/examples/VolUfl and type make.
  7. type ufl to run an instance of the uncapacitated facility location problem.

Step 1 issues the subversion command to obtain the source code. Alternatively one can obtain the source code for the latest release (https://projects.coin-or.org/Vol/chrome/site/Vol-latest.png) from the tarball directory.

Step 3 runs a configure script that generates the make file.

Step 4 builds the Vol library and executable program.

Step 5 installs libraries, executables and header files in directories coin-Vol/lib, coin-Vol/bin and coin-Vol/include. The BuildTools project has additional details on down loading, building, and installing.

Step 6 creates an example of how to use the volume algorithm for the uncapacitated facility location problem.

Step 7 runs an instance of uncapacitated facility location.

In the directory Vol/examples there are other examples of implementations. More information is in "Overview of different directories" in the documentation.


Included Projects

If you download the Vol package, you get these additional projects.


Doxygen Documentation

If you have Doxygen available, you can build the html documentation by typing

make doxydoc

in the directory coin-Vol. Then open the file coin-Vol/doxydoc/html/index.html with a browser. Note that this creates the documentation for the Vol package. If you prefer to generate the documentation only for a subset of these projects, you can edit the file coin-Vol/doxydoc/doxygen.conf to exclude directories (using the EXCLUDE variable, for example).

If Doxygen is not available, you can use the link to the Vol html documentation listed below.


Documentation


Last modified 6 years ago Last modified on Mar 4, 2011 12:20:43 PM

Attachments (1)

Download all attachments as: .zip