maxsum-cpp

Implementation of the Max-Sum Algorithm in C++

The API documentation for this library can be viewed online here.

Dependencies

This project currently has two third party library dependencies:

1. Eigen3: http://eigen.tuxfamily.org; and

2. Boost 1.48 or later: http://www.boost.org.

doxygen is required to compile documentation in html. In addition, LaTeX is required to generate forumla's included in the html, and to generate a pdf version of the documentation.

Installation

Install CMake (see http://www.cmake.org/) and follow the general instructions for building CMake projects for your platform. For example, on most unix-like platforms (including Mac OS X) it is usually sufficient to run the following commands:

cd maxsum-cpp
cmake .
make

Optionally, to run unit tests:

ctest .

And to build documentation:

make doc

If your platform has multiple cores, both make and ctest can run in parallel, by specifying the number of cores on the command line. For example, on a 4 core machine, run:

make -j 4
ctest -j 4

Known Issues

Currently builds with Eigen 3.2.5 and Boost 1.58.0 on Mac OS X. There may be issues with other versions of these libraries that need to be resolved.

License

Copyright © 2013 Luke Teacy. All Rights Reserved.

Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY LUKE TEACY "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.