Algaroba

An eager solver for algebraic data types

Install Dependencies

First install opam and dune. This was tested using dune version 3.10.0, opam version 2.1.5, and OCaml version 5.0.0. Then do

opam install -y --deps-only .

Install

dune build
dune install

Usage

algaroba <query> [options]
  -o Write to an output file
  -t Set a timeout for solving (in milliseconds)
  --z3-simplifier Use a Z3 simplifier.
  --dont-depth-based-acyclicality-pause Normally, we do unrolling at half of the average depth. If set to true we don't do this
  --acyclicality-pause Point in depth to pause and check
  --measure Measure time spent in each step
  --global-z3-parameter Use a Z3 global parameter.
  --set-z3-solver-flag Set a Z3 solver flag to true.
  --clear-z3-solver-flag Set a Z3 solver flag to false.
  --assert-conjunctions Rewrite top-level conjunctions to assertions (default: false)
  --simplify-ite Rewrite if-then-else statements to use normal boolean operations  (default: false)
  --constant-prop Does propagation for variables set to symbolic constants  (default: false)
  --inline-constants Decides whether to inline constants (WARNING: choosing true is not sound as currently implemented) (default: false)
  --use-enum-test-axioms Decides whether to use the enum tester axioms or not (default: true)
  --print-depths Decides whether to print depths to stderr (default: false)
  -help  Display this list of options
  --help  Display this list of options

Testing

Run testing.py to replicate our results. This will create a csv in test/dataframes, a graph in test/graphs, and will print the results to stdout. If you would like to replicate our comparison to Z3, CVC5, and Princess, then you will need to install those tools. There are several options in testing.py that you can modify:

timeout: default is 1200 seconds
test_case: can be 'Barrett', 'Bouvier', 'BouvierUF', or 'blocksworld'
output_name: the name for the output
run_pre_solvers: decides whether to run z3, cvc5, and princess
princess path: the path to run princess, default is 'princess'
z3 path: the path to run z3, default is 'z3'
cvc5 path: the path to run cvc5, default is 'cvc5'
algaroba flags: can run the solver with different flags to compare, default is just '{"algaroba": []}', i.e. no flags

Citation

If you use Algaroba in your work please cite the following paper:

@inproceedings{algaroba24,
  author       = {Amar Shah and
                  Federico Mora and
                  Sanjit A. Seshia},
  editor       = {Michael J. Wooldridge and
                  Jennifer G. Dy and
                  Sriraam Natarajan},
  title        = {An Eager Satisfiability Modulo Theories Solver for Algebraic Datatypes},
  booktitle    = {Thirty-Eighth {AAAI} Conference on Artificial Intelligence, {AAAI}
                  2024, Thirty-Sixth Conference on Innovative Applications of Artificial
                  Intelligence, {IAAI} 2024, Fourteenth Symposium on Educational Advances
                  in Artificial Intelligence, {EAAI} 2014, February 20-27, 2024, Vancouver,
                  Canada},
  pages        = {8099--8107},
  publisher    = {{AAAI} Press},
  year         = {2024},
  url          = {https://doi.org/10.1609/aaai.v38i8.28649},
  doi          = {10.1609/AAAI.V38I8.28649},
  timestamp    = {Tue, 02 Apr 2024 16:32:08 +0200},
  biburl       = {https://dblp.org/rec/conf/aaai/ShahMS24.bib}
}