Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 4.46 KB

README.md

File metadata and controls

92 lines (61 loc) · 4.46 KB
Raw

Huub logo

Huub is a Lazy Clause Generation (LCG) solver with a focus on modularity and maintainability in addition to speed. LCG solvers are a class of solvers that can be used to solve decision and optimization problems. They are characterized by their ability to dynamically add new Boolean variables and clauses to a Boolean Satisfiability (SAT) solver during the search process. This allows the solver exploit SAT solver's ability to learn from failures during the search process, without having to encode the full problem into Boolean variables and clauses.

Documentation

Documentation

Installation

Huub can be used either as a MiniZinc solver or as a standalone Rust modelling and solving library for decision and optimization problems.

Installing Huub as a MiniZinc solver

  1. Download the latest release of Huub from the releases page and download the fzn-huub archive that matches your system.
  2. Extract (and install) the downloaded archive to a sensible location on your system.
  3. Add the share/solvers directory from the extracted archive to the MZN_SOLVER_PATH environment variable.
  4. Huub should now show up in the list of solvers when running minizinc --solvers and in the MiniZinc IDE.

Installing Huub as a Rust library

The following command can be used to add Huub as a dependency to your Rust project.

cargo add huub

Naming

Huub is named after Hubertus Dekker, a passionate business administration and accounting teacher who spent his holidays creating the rosters for his school by hand, allowing students to pick any combination of possible subjects. This solver is dedicated to him in the hope that it allows problems to be solved with the same flexibility and care that he put into his rosters. The logo of the solver is based on an old caricature of him as a teacher, made to include his features at an older age.

Authors

Acknowledgements

This research was partially funded by the Australian Government through the Australian Research Council Industrial Transformation Training Centre in Optimization Technologies, Integrated Methodologies, and Applications (OPTIMA), Project ID IC200100009.

Related

Huub is built using the IPASIR-UP interface for SAT solvers, proposed by Fazakas et al.. Huub is tested with the following solvers that implement this interface.

The connection to SAT solvers and encoding methods to SAT for Huub use Pindakaas, a Rust crate for SAT solving and encoding to SAT.

Huub is inspired by the following LCG solvers, among others.

Development

When working on the integration of Huub with MiniZinc, you would likely want to compile a MiniZinc instance and run it using a current build of fzn-huub. This process can be split into two steps. First, the required .fzn.json and .ozn files can be produced using the following command.

minizinc --solver share/minizinc/solvers/huub.msc --compile [OTHER FLAGS AND INSTANCE FILES]

Then, you can run the current version of fzn-huub using cargo and pipe the result back into MiniZinc to evaluate the output using the following command.

cargo run [BUILD FLAGS] -- [HUUB FLAGS AND FZNJSON FILE] | minizinc --ozn-file [OZN FILE]

Note that if you are intending to use a debugger on fzn-huub, then you would find the latest build in ./target/debug or ./target/release-with-debug (created using cargo build or cargo build --profile release-with-debug) to give to the debugger in combination with the [HUUB FLAGS AND FZNJSON FILE]. For example, the following command can be used to run fzn-huub with the lldb debugger.

lldb -- ./target/debug/fzn-huub [HUUB FLAGS AND FZNJSON FILE]