Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 4.02 KB

README.md

File metadata and controls

123 lines (90 loc) · 4.02 KB
Raw

SAT-tfg

This project is an environment to work with Pseudo-Boolean optimisation problems and Boolean formulae.

Code example

Formula a = BoolFunc::newLit("a");
Formula b = BoolFunc::newLit("b");

Formula c = a + b;
Cnf tseitin = CnfConverter::tseitin(c);
tseitin.print();

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Table of contents

  • Installation
  • Usage
  • Built With
  • Contributing
  • Versioning
  • Authors
  • License
  • Acknowledgments

Installation

Requirements

For installing and running, there are four requirements. This must be present in the system:

  • cmake: CMake is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice.
  • picosat: A SAT solvers
  • minisat: A SAT solver
  • zlib1g-dev: zlib is a library implementing the deflate compression method found in gzip and PKZIP

The first three need to be accessible through the cml:

$ picosat --version
$ cmake --version
$ minisat

How to download it and install it

Download the project. It is recommended to download always stable versions:

$ wget https://github.com/marcbenedi/SAT-tfg/archive/v1.2.zip
$ unzip  v1.2.zip

This will create SAT-tfg-1.2 directory.

To install this project execute:

$ chmod +x installer.sh
$ ./installer.sh

This script will install the following libraries:

Finally, it will execute the tests.

Usage

Check the Wiki page.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

For the versions available, see the tags on this repository. It is always recommended to use the latest version.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

MIT License

Copyright (c) 2018 Marc Benedí

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Acknowledgments