arnaud-m/choco-solver

Documentation, Support and Issues
Contributing
Download and installation

Choco-solver is an open-source Java library for Constraint Programming.

Current stable version is 4.10.1 (26 Jun 2019).

Choco-solver comes with:

various type of variables (integer, boolean, set, graph and real),
various state-of-the-art constraints (alldifferent, count, nvalues, etc.),
various search strategies, from basic ones (first_fail, smallest, etc.) to most complex (impact-based and activity-based search),
explanation-based engine, that enables conflict-based back jumping, dynamic backtracking and path repair,

But also, facilities to interact with the search loop, factories to help modelling, many samples, etc.

Overview

// 1. Create a Model
Model model = new Model("my first problem");
// 2. Create variables
IntVar x = model.intVar("X", 0, 5);
IntVar y = model.intVar("Y", 0, 5);
// 3. Create and post constraints thanks to the model
model.element(x, new int[]{5,0,4,1,3,2}, y).post();
// 3b. Or directly through variables
x.add(y).lt(5).post();
// 4. Get the solver
Solver solver = model.getSolver();
// 5. Define the search strategy
solver.setSearch(Search.inputOrderLBSearch(x, y));
// 6. Launch the resolution process
solver.solve();
// 7. Print search statistics
solver.printStatistics();

Documentation, Support and Issues

The latest release points to a tarball which contains the binary, the source code, the user guide (pdf) and the apidocs (zip).

You can get help on our google group. Most support requests are answered very fast.

Use the issue tracker here on GitHub to report issues. As far as possible, provide a Minimal Working Example.

Contributing

Anyone can contribute to the project, from the source code to the documentation. In order to ease the process, we established a contribution guide that should be reviewed before starting any contribution as it lists the requirements and good practices to ease the contribution process.

Promoting is contributing !

Following are code snippets to add on your website to help us promoting Choco-solver.

html:

<a href="http://www.choco-solver.org/?utm_source=badge&utm_medium=badge&utm_campaign=badge">
<img border="0" alt="Choco-solver" src="http://www.choco-solver.org/img/banner.svg" width="160" height="18">
</a>

Markdown:

[![Choco-solver](http://www.choco-solver.org/img/banner.svg)](http://www.choco-solver.org/?utm_source=badge&utm_medium=badge&utm_campaign=badge)

And thank you for giving back to choco-solver. Please meet our team of cho-coders :

@jgFages (Jean-Guillaume Fages)
@cprudhom (Charles Prud'homme)

Donating is contributing too!

Supporting Choco with financial aid favors long-term support and development. Our expenses are varied: fees (GitHub organization, Domain name, etc), funding PhD students or internships, conferences, hardware renewal, ...

Download and installation

Requirements:

JDK 8+
maven 3+

Choco-solver is available on Maven Central Repository, or directly from the latest release.

Snapshot releases are also available for curious.

In the following, we distinguish two usages of Choco:

as a standalone application: the jar file includes all required dependencies,
as a library: the jar file excludes all dependencies.

The name of the jar file terms the packaging: choco-solver-4.10.1.jar or choco-solver-4.10.1-no-dep.jar.

A Changelog file is maintained for each release.

Inside a maven project

Choco is available on Maven Central Repository. So you only have to edit your pom.xml to declare the following library dependency:

<dependency>
   <groupId>org.choco-solver</groupId>
   <artifactId>choco-solver</artifactId>
   <version>4.10.1</version>
</dependency>

Note that if you want to test snapshot release, you should update your pom.xml with :

<repository>
    <id>sonatype</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
</repository>

As a stand-alone application

The jar file contains all required dependencies. The next step is simply to add the jar file to your classpath of your application. Note that if your program depends on dependencies declared in the jar file, you should consider using choco as a library.

As a library

The jar file does not contains any dependencies, as of being used as a dependency of another application. The next step is to add the jar file to your classpath of your application and also add the required dependencies.

Dependencies

The required dependencies for compilation are:

de.erichseifert.vectorgraphics2d:VectorGraphics2D:0.13
org.jheaps:jheaps:0.10
org.jgrapht:jgrapht-core:1.3.1
org.choco-solver:cutoffseq:1.0.5
com.github.cp-profiler:cpprof-java:1.3.0
dk.brics.automaton:automaton:1.11-8
org.choco-solver:choco-sat:1.0.2
net.sf.trove4j:trove4j:3.0.3
org.knowm.xchart:xchart:3.5.4
com.google.protobuf:protobuf-java:2.6.1

They are available on Maven Repository.

To declare continuous constraints, Ibex-2.6.5 needs to be installed (instructions are given on Ibex website).

Building from sources

The source of the released versions are directly available in the Tag section. You can also download them using github features. Once downloaded, move to the source directory then execute the following command to make the jar:

$ mvn clean package -DskipTests

If the build succeeded, the resulting jar will be automatically installed in your local maven repository and available in the target sub-folders.

Choco-solver dev team

arnaud-m / choco-solver