Projects such as this one are maintained by a small group of volunteers under the auspices of the non-profit COIN-OR Foundation and we need your help! Please consider sponsoring our activities or volunteering to help!
This file is auto-generated from config.yml using the generate_readme script. To make changes, please edit config.yml or the generation scripts here and here.
CoinMP is a C-API interface library that supports most of the
functionality of the CLP (Coin LP), CBC (Coin Branch-and-Cut), and CGL (Cut
Generation Library) projects. It is built as a shared library (libCoinMP,
or CoinMP.dll on Windows) that can be used from other C/C++ projects and
applications. The header file src/CoinMP.h contains the prototypes of all
functions of the library.
CoinMP is written in C++ and is released as open source under the Eclipse Public License 2.0.
It is distributed under the auspices of the COIN-OR Foundation.
The CoinMP development site is https://github.com/coin-or/CoinMP.
What follows is a quick start guide for obtaining or building CoinMP on common platforms. More detailed information is available here.
There is a Docker image that provides CoinMP, as well as other projects in the COIN-OR Optimization Suite here.
For newer releases, binaries will be made available as assets attached to releases in Github here. Older binaries are archived as part of CoinMP here.
- Linux (see https://repology.org/project/coinmp/versions for a complete listing):
- Arch Linux:
sudo pacman -S coin-or-mp - Debian and Ubuntu:
sudo apt install coinor-libcoinmp-dev
- Arch Linux:
- FreeBSD:
sudo pkg install math/coinmp - Windows: The easiest way to get CoinMP on Windows is to download an archive as described above.
With MSYS2, in the UCRT64 environment, do
pacman -S mingw-w64-ucrt-x86_64-coin-or-mp - conda (cross-platform):
conda install -c conda-forge coinmp
Due to license incompatibilities, pre-compiled binaries lack some functionality. If binaries are not available for your platform for the latest version and you would like to request them to be built and posted, feel free to open a discussion on Github.
Source code can be obtained either by
- Downloading a snapshot of the source code for the latest release version of CoinMP from the releases page,
- Cloning this repository from Github, or
- Using the coinbrew script to get the project and all dependencies (recommended, see below).
CoinMP has a number of dependencies, which are detailed in
config.yml. Dependencies on other COIN-OR projects are
automatically downloaded when obtaining the source with coinbrew. For some
of the remaining third-party dependencies, automatic download scripts and
build wrappers are provided (and will also be automatically run for required
and recommended dependencies), while other libraries that are easy to obtain
must be installed using an appropriate package manager (or may come with your
OS by default).
These quick start instructions assume you are in a bash shell.
To download and build CoinMP from source, execute the following on the command line.
wget https://raw.githubusercontent.com/coin-or/coinbrew/master/coinbrew
chmod u+x coinbrew
./coinbrew fetch CoinMP@master
./coinbrew build CoinMP
For more detailed instructions on coinbrew, see https://coin-or.github.io/coinbrew.
The coinbrew script will fetch the additional projects specified in the Dependencies section of config.yml.
- Download the source code, e.g., by cloning the git repo https://github.com/coin-or/CoinMP
- Download and install the source code for the dependencies listed in config.yml
- Build the code as follows (make sure to set
PKG_CONFIG_PATHto thelib/pkgconfigdirectory of the installation of the dependencies).
./configure -C
make
make test
make install
The examples directory has a C program that solves a few small problems
with CoinMP. After building and installing CoinMP, it can be built by running
make in the corresponding subdirectory of the build directory, e.g.,
cd build/CoinMP/master/examples
make
./example