cryptominisat 5.8.0

// Copyright (c) 2016 Robert Grosse

// 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.

extern crate libc;
use libc::size_t;
use std::slice;

/// The maximum number of variables allowed by the solver
pub const MAX_NUM_VARS: size_t = (1 << 28) - 1;

// cryptominisat types
enum SATSolver {} // opaque pointer

#[repr(C)]
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Debug)]
pub struct Lit(u32);
impl Lit {
    /// Returns None if var >= 1 << 31, but you should not rely on var >= MAX_NUM_VARS
    pub fn new(var: u32, negated: bool) -> Option<Lit> {
        if var < (1 << 31) {
            Some(Lit(var << 1 | (negated as u32)))
        } else {
            None
        }
    }
    /// The underlying variable
    pub fn var(&self) -> u32 {
        self.0 >> 1
    }
    /// Whether this literal is negated
    pub fn isneg(&self) -> bool {
        self.0 & 1 != 0
    }
}
impl std::ops::Not for Lit {
    type Output = Lit;
    /// Negate this literal
    fn not(self) -> Lit {
        Lit(self.0 ^ 1)
    }
}

#[repr(u8)]
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
pub enum Lbool {
    True = 0,
    False = 1,
    Undef = 2,
}
impl Lbool {
    pub fn from(b: bool) -> Lbool {
        if b { Lbool::True } else { Lbool::False }
    }
}

#[repr(C)]
struct slice_from_c<T>(*const T, size_t);
unsafe fn to_slice<'a, T>(raw: slice_from_c<T>) -> &'a [T] {
    slice::from_raw_parts(raw.0, raw.1)
}

#[link(name = "cryptominisat5")]
extern "C" {
    fn cmsat_new() -> *mut SATSolver;
    fn cmsat_free(this: *mut SATSolver);
    fn cmsat_nvars(this: *const SATSolver) -> u32;
    fn cmsat_add_clause(this: *mut SATSolver, lits: *const Lit, num_lits: size_t) -> bool;
    fn cmsat_add_xor_clause(this: *mut SATSolver,
                            vars: *const u32,
                            num_vars: size_t,
                            rhs: bool)
                            -> bool;
    fn cmsat_new_vars(this: *mut SATSolver, n: size_t);
    fn cmsat_solve(this: *mut SATSolver) -> Lbool;
    fn cmsat_solve_with_assumptions(this: *mut SATSolver,
                                    assumptions: *const Lit,
                                    num_assumptions: size_t)
                                    -> Lbool;
    fn cmsat_simplify(this: *mut SATSolver,
                                    assumptions: *const Lit,
                                    num_assumptions: size_t)
                                    -> Lbool;
    fn cmsat_get_model(this: *const SATSolver) -> slice_from_c<Lbool>;
    fn cmsat_get_conflict(this: *const SATSolver) -> slice_from_c<Lit>;
    fn cmsat_set_verbosity(this: *mut SATSolver, n: u32);
    fn cmsat_set_num_threads(this: *mut SATSolver, n: u32);
    fn cmsat_set_default_polarity(this: *mut SATSolver, polar: bool);
    fn cmsat_set_polarity_auto(this: *mut SATSolver);
    fn cmsat_set_no_simplify(this: *mut SATSolver);
    fn cmsat_set_no_simplify_at_startup(this: *mut SATSolver);
    fn cmsat_set_no_equivalent_lit_replacement(this: *mut SATSolver);
    fn cmsat_set_no_bva(this: *mut SATSolver);
    fn cmsat_set_no_bve(this: *mut SATSolver);
    fn cmsat_set_up_for_scalmc(this: *mut SATSolver);
    fn cmsat_set_yes_comphandler(this: *mut SATSolver);
    fn cmsat_print_stats(this: *mut SATSolver);
    fn cmsat_set_max_time(this: *mut SATSolver, max_time: f64);
}

pub struct Solver(*mut SATSolver);
impl Drop for Solver {
    fn drop(&mut self) {
        unsafe { cmsat_free(self.0) };
    }
}
impl Solver {
    /// Create new solver instance
    pub fn new() -> Solver {
        Solver(unsafe { cmsat_new() })
    }
    /// Current number of variables. Call new_var() or new_vars() to increase this.
    pub fn nvars(&self) -> u32 {
        unsafe { cmsat_nvars(self.0) }
    }
    /// Current number of variables
    pub fn add_clause(&mut self, lits: &[Lit]) -> bool {
        unsafe { cmsat_add_clause(self.0, lits.as_ptr(), lits.len()) }
    }
    /// Add a xor clause, which enforces that the xor of the unnegated variables equals rhs.
    /// It is generally more convienent to use add_xor_literal_clause() instead.
    pub fn add_xor_clause(&mut self, vars: &[u32], rhs: bool) -> bool {
        unsafe { cmsat_add_xor_clause(self.0, vars.as_ptr(), vars.len(), rhs) }
    }
    /// Adds n new variabless.
    pub fn new_vars(&mut self, n: size_t) {
        unsafe { cmsat_new_vars(self.0, n) }
    }
    /// Solve and return Lbool::True if a solution was found.
    pub fn solve(&mut self) -> Lbool {
        unsafe { cmsat_solve(self.0) }
    }
    /// Solve under the assumption that the passed literals are true and return Lbool::True if a solution was found.
    pub fn solve_with_assumptions(&mut self, assumptions: &[Lit]) -> Lbool {
        unsafe { cmsat_solve_with_assumptions(self.0, assumptions.as_ptr(), assumptions.len()) }
    }
    /// Returns true/false/unknown status for each variable.
    pub fn get_model(&self) -> &[Lbool] {
        unsafe { to_slice(cmsat_get_model(self.0)) }
    }
    /// Return conflicts for assumptions that led to unsatisfiability.
    pub fn get_conflict(&self) -> &[Lit] {
        unsafe { to_slice(cmsat_get_conflict(self.0)) }
    }
    /// Set number of threads used for solving. Must not be called after other methods.
    pub fn set_num_threads(&mut self, n: u32) {
        unsafe { cmsat_set_num_threads(self.0, n) }
    }

    /// Set verbosity
    pub fn set_verbosity(&mut self, n: u32) {
        unsafe { cmsat_set_verbosity(self.0, n) }
    }

    /// Helper that adds a variable and returns the corresponding literal.
    pub fn new_var(&mut self) -> Lit {
        let n = self.nvars();
        self.new_vars(1);
        Lit::new(n as u32, false).unwrap()
    }
    /// Wrapper which calls get_model() and returns whether the given literal is true.
    pub fn is_true(&self, lit: Lit) -> bool {
        self.get_model()[lit.var() as usize] == Lbool::from(!lit.isneg())
    }
    /// Wrapper which converts literals to variables and then calls add_xor_clause()
    pub fn add_xor_literal_clause(&mut self, lits: &[Lit], mut rhs: bool) -> bool {
        let mut vars = Vec::with_capacity(lits.len());
        for lit in lits {
            vars.push(lit.var());
            rhs ^= lit.isneg();
        }
        self.add_xor_clause(&vars, rhs)
    }

     /// Set a limit on the running time
    pub fn set_max_time(&mut self, max_time: f64) {
        unsafe { cmsat_set_max_time(self.0, max_time) }
    }

    pub fn set_default_polarity(&mut self, polar: bool) {
        unsafe { cmsat_set_default_polarity(self.0, polar) }
    }
    pub fn set_polarity_auto(&mut self) {
        unsafe { cmsat_set_polarity_auto(self.0) }
    }

    pub fn set_no_simplify(&mut self) {
        unsafe { cmsat_set_no_simplify(self.0) }
    }
    pub fn set_no_simplify_at_startup(&mut self) {
        unsafe { cmsat_set_no_simplify_at_startup(self.0) }
    }
    pub fn set_no_equivalent_lit_replacement(&mut self) {
        unsafe { cmsat_set_no_equivalent_lit_replacement(self.0) }
    }
    pub fn set_no_bva(&mut self) {
        unsafe { cmsat_set_no_bva(self.0) }
    }
    pub fn set_no_bve(&mut self) {
        unsafe { cmsat_set_no_bve(self.0) }
    }
    pub fn set_up_for_scalmc(&mut self) {
        unsafe { cmsat_set_up_for_scalmc(self.0) }
    }
    pub fn print_stats(&mut self) {
        unsafe { cmsat_print_stats(self.0) }
    }

    pub fn set_yes_comphandler(&mut self) {
        unsafe { cmsat_set_yes_comphandler(self.0) }
    }

    pub fn simplify(&mut self, assumptions: &[Lit]) -> Lbool {
        unsafe { cmsat_simplify(self.0, assumptions.as_ptr(), assumptions.len()) }
    }
}