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.
CoinUtils is an open-source collection of classes and helper functions that are generally useful to multiple COIN-OR projects. These utilities include:
- classes for storing and manipulating sparse matrices and vectors,
- performing matrix factorization,
- parsing input files in standard formats, e.g. MPS,
- building representations of mathematical programs,
- performing simple presolve operations,
- warm starting algorithms for mathematical programs,
- comparing floating point numbers with a tolerance
- classes for storing and manipulating conflict graphs, and
- classes for searching and storing cliques and odd cycles in conflict graphs, among others.
CoinUtils 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 CoinUtils development site is https://github.com/coin-or/CoinUtils.
Code:
What follows is a quick start guide for obtaining or building CoinUtils on common platforms. More detailed information is available here.
There is a Docker image that provides CoinUtils, 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 Cbc here.
-
Linux (see https://repology.org/project/coin-or-coinutils/versions for a complete listing):
- arch:
$ sudo pacman -S coin-or-coinutils - Debian/Ubuntu:
$ sudo apt-get install coinor-coinutils coinor-libcoinutils-dev - Fedora/Redhat/CentOS:
$ sudo yum install coin-or-CoinUtils coin-or-CoinUtils-devel - freebsd:
$ sudo pkg install math/coinutils - linuxbrew:
$ brew install coinutils
- arch:
-
Windows: The easiest way to get CoinUtils on Windows is to download an archive as described above.
-
Mac OS X: The easiest way to get CoinUtils on Mac OS X is through Homebrew.
$ brew tap coin-or-tools/coinor $ brew install coin-or-tools/coinor/coinutils -
conda (cross-platform, no Windows for now):
$ conda install coin-or-coinutils
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 let us know on the mailing list.
Source code can be obtained either by
- Downloading a snapshot of the source code for the latest release version of CoinUtils from the releases page,
- Cloning this repository from Github, or
- Using the coinbrew script to get the project and all dependencies (recommended, see below).
CoinUtils 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 aeasy 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 CoinUtils 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 CoinUtils@master
./coinbrew build CoinUtils
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/CoinUtils
- Download and install the source code for the dependencies listed in config.yml
- Build the code as follows (make sure to set PKG_CONFIG_PTH to install directory for dependencies).
./configure -C
make
make test
make install
If you have Doxygen available, you can build a HTML documentation by typing
make doxygen-docs
in the build directory. If CoinUtils was built via coinbrew, then the build
directory will be ./build/CoinUtils/master by default. The doxygen documentation main file
is found at <build-dir>/doxydoc/html/index.html.
If you don't have doxygen installed locally, you can use also find the
documentation here.