Adding API for AtMostOneConstraint + bugfix for turning off the optimizations
[satune.git] / src / csolver.h
index 92900a19468eb386ce861b8c427e91638279c9d1..5ef235d3d8ce9b26032380b30c4cea82c85bd0f2 100644 (file)
@@ -1,14 +1,17 @@
 #ifndef CSOLVER_H
 #define CSOLVER_H
-#include "classlist.h"
+#include "classes.h"
 #include "ops.h"
-#include "structs.h"
+#include "corestructs.h"
+#include "asthash.h"
+#include "solver_interface.h"
+#include "common.h"
 
 class CSolver {
 public:
        CSolver();
        ~CSolver();
-
+       void resetSolver();
        /** This function creates a set containing the elements passed in the array. */
        Set *createSet(VarType type, uint64_t *elements, uint num);
 
@@ -16,12 +19,22 @@ public:
 
        Set *createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange);
 
-       /** This function creates a mutable set. */
+       bool itemExistInSet(Set *set, uint64_t item);
+
+       VarType getSetVarType(Set *set);
+
+       Element *createRangeVar(VarType type, uint64_t lowrange, uint64_t highrange);
+
+       /** This function creates a mutable set.
+        * Note: You should use addItem for adding new item to Mutable sets, and
+        * at the end, you should call finalizeMutableSet!
+        */
 
        MutableSet *createMutableSet(VarType type);
 
        /** This function adds a new item to a set. */
 
+       //Deprecating this unless we need it...
        void addItem(MutableSet *set, uint64_t element);
 
        /** This function adds a new unique item to the set and returns it.
@@ -30,6 +43,11 @@ public:
 
        uint64_t createUniqueItem(MutableSet *set);
 
+       /**
+        * Freeze and finalize the mutableSet ...
+        */
+       void finalizeMutableSet(MutableSet *set);
+
        /** This function creates an element variable over a set. */
 
        Element *getElementVar(Set *set);
@@ -37,26 +55,34 @@ public:
        /** This function creates an element constrant. */
        Element *getElementConst(VarType type, uint64_t value);
 
+       Set *getElementRange (Element *element);
+
+       void mustHaveValue(Element *element);
+
+       BooleanEdge getBooleanTrue();
+
+       BooleanEdge getBooleanFalse();
+
        /** This function creates a boolean variable. */
 
-       Boolean *getBooleanVar(VarType type);
+       BooleanEdge getBooleanVar(VarType type);
 
        /** This function creates a function operator. */
 
-       Function *createFunctionOperator(ArithOp op, Set **domain, uint numDomain, Set *range,
+       Function *createFunctionOperator(ArithOp op, Set *range,
                                                                                                                                         OverFlowBehavior overflowbehavior);
 
        /** This function creates a predicate operator. */
 
-       Predicate *createPredicateOperator(CompOp op, Set **domain, uint numDomain);
+       Predicate *createPredicateOperator(CompOp op);
 
        Predicate *createPredicateTable(Table *table, UndefinedBehavior behavior);
 
        /** This function creates an empty instance table.*/
 
-       Table *createTable(Set **domains, uint numDomain, Set *range);
+       Table *createTable(Set *range);
 
-       Table *createTableForPredicate(Set **domains, uint numDomain);
+       Table *createTableForPredicate();
        /** This function adds an input output relation to a table. */
 
        void addTableEntry(Table *table, uint64_t *inputs, uint inputSize, uint64_t result);
@@ -67,74 +93,118 @@ public:
 
        /** This function applies a function to the Elements in its input. */
 
-       Element *applyFunction(Function *function, Element **array, uint numArrays, Boolean *overflowstatus);
+       Element *applyFunction(Function *function, Element **array, uint numArrays, BooleanEdge overflowstatus);
 
        /** This function applies a predicate to the Elements in its input. */
 
-       Boolean *applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, Boolean *undefinedStatus);
+       BooleanEdge applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, BooleanEdge undefinedStatus);
+
+       BooleanEdge applyPredicate(Predicate *predicate, Element **inputs, uint numInputs);
+
+       /** This exactly one element of array can be true! (i.e. a1 + a2 + a3 + ... + an = 1)*/
+       BooleanEdge applyExactlyOneConstraint (BooleanEdge *array, uint asize);
+       
+       /** This exactly one element of array can be true! (i.e. a1 => !a2 & !a3 & ... & !an)*/
+       BooleanEdge applyAtMostOneConstraint (BooleanEdge *array, uint asize);
+
+       /** This function applies a logical operation to the Booleans in its input. */
 
-       Boolean *applyPredicate(Predicate *predicate, Element **inputs, uint numInputs);
+       BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge *array, uint asize);
 
        /** This function applies a logical operation to the Booleans in its input. */
 
-       Boolean *applyLogicalOperation(LogicOp op, Boolean **array, uint asize);
+       BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge arg1, BooleanEdge arg2);
+
+       /** This function applies a logical operation to the Booleans in its input. */
+
+       BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge arg);
 
        /** This function adds a boolean constraint to the set of constraints
            to be satisfied */
 
-       void addConstraint(Boolean *constraint);
+       void addConstraint(BooleanEdge constraint);
 
        /** This function instantiates an order of type type over the set set. */
        Order *createOrder(OrderType type, Set *set);
 
        /** This function instantiates a boolean on two items in an order. */
-       Boolean *orderConstraint(Order *order, uint64_t first, uint64_t second);
+       BooleanEdge orderConstraint(Order *order, uint64_t first, uint64_t second);
 
        /** When everything is done, the client calls this function and then csolver starts to encode*/
-       int startEncoding();
+       int solve();
+       /**
+        * Incremental Solving for SATUNE.
+        * It only supports incremental solving for elements!
+        * No support for BooleanVar, BooleanOrder or using interpreters
+        * @return
+        */
+       int solveIncremental();
 
        /** After getting the solution from the SAT solver, client can get the value of an element via this function*/
        uint64_t getElementValue(Element *element);
 
+       void freezeElement(Element *e);
+       void turnoffOptimizations(){optimizationsOff = true;}
        /** After getting the solution from the SAT solver, client can get the value of a boolean via this function*/
-       bool getBooleanValue(Boolean *boolean);
+       bool getBooleanValue(BooleanEdge boolean);
 
-       HappenedBefore getOrderConstraintValue(Order *order, uint64_t first, uint64_t second);
+       bool getOrderConstraintValue(Order *order, uint64_t first, uint64_t second);
 
-       void setUnSAT() { unsat = true; }
+       bool isTrue(BooleanEdge b);
+       bool isFalse(BooleanEdge b);
 
+       void setUnSAT() { model_print("Setting UNSAT %%%%%%\n"); unsat = true; }
+       void setSatSolverTimeout(long seconds) { satsolverTimeout = seconds;}
        bool isUnSAT() { return unsat; }
+       bool isBooleanVarUsed() {return booleanVarUsed;}
+       void printConstraint(BooleanEdge boolean);
+       void printConstraints();
 
        Vector<Order *> *getOrders() { return &allOrders;}
+       HashsetOrder *getActiveOrders() { return &activeOrders;}
 
        Tuner *getTuner() { return tuner; }
-       
-       HSIteratorBoolean *getConstraints() { return constraints.iterator(); }
+
+       SetIteratorBooleanEdge *getConstraints() { return constraints.iterator(); }
+       bool isConstraintEncoded(BooleanEdge be) { return encodedConstraints.contains(be);}
+       void addEncodedConstraint(BooleanEdge be) {encodedConstraints.add(be);}
 
        SATEncoder *getSATEncoder() {return satEncoder;}
 
-       void replaceBooleanWithTrue(Boolean *bexpr);
-       void replaceBooleanWithFalse(Boolean *bexpr);
-       void replaceBooleanWithBoolean(Boolean *oldb, Boolean *newb);
+       void replaceBooleanWithTrue(BooleanEdge bexpr);
+       void replaceBooleanWithTrueNoRemove(BooleanEdge bexpr);
+       void replaceBooleanWithFalseNoRemove(BooleanEdge bexpr);
+       void replaceBooleanWithFalse(BooleanEdge bexpr);
+       void replaceBooleanWithBoolean(BooleanEdge oldb, BooleanEdge newb);
        CSolver *clone();
+       void serialize();
+       static CSolver *deserialize(const char *file, InterpreterType itype = SATUNE);
        void autoTune(uint budget);
-
-       void setTuner(Tuner * _tuner) { tuner = _tuner; }
+       void inferFixedOrders();
+       void inferFixedOrder(Order *order);
+       void setInterpreter(InterpreterType type);
+       bool useInterpreter() {return interpreter != NULL;}
+       void setTuner(Tuner *_tuner) { tuner = _tuner; }
        long long getElapsedTime() { return elapsedTime; }
        long long getEncodeTime();
        long long getSolveTime();
-       
-       MEMALLOC;
+       long getSatSolverTimeout() { return satsolverTimeout;}
+       bool isIncrementalMode() {return incrementalMode;}
+       void freezeElementsVariables();
+       CMEMALLOC;
 
 private:
-       void handleXORFalse(BooleanLogic *bexpr, Boolean *child);
-       void handleIMPLIESTrue(BooleanLogic *bexpr, Boolean *child);
-       void handleIMPLIESFalse(BooleanLogic *bexpr, Boolean *child);
-       void handleANDTrue(BooleanLogic *bexpr, Boolean *child);
-       void handleORFalse(BooleanLogic *bexpr, Boolean *child);
-
+       void handleIFFTrue(BooleanLogic *bexpr, BooleanEdge child);
+       void handleANDTrue(BooleanLogic *bexpr, BooleanEdge child);
+       void handleFunction(ElementFunction *ef, BooleanEdge child);
+
+       //These two functions are helpers if the client has a pointer to a
+       //Boolean object that we have since replaced
+       BooleanEdge rewriteLogicalOperation(LogicOp op, BooleanEdge *array, uint asize);
+       BooleanEdge doRewrite(BooleanEdge b);
        /** This is a vector of constraints that must be satisfied. */
-       HashSetBoolean constraints;
+       HashsetBooleanEdge constraints;
+       HashsetBooleanEdge encodedConstraints;
 
        /** This is a vector of all boolean structs that we have allocated. */
        Vector<Boolean *> allBooleans;
@@ -154,13 +224,61 @@ private:
        /** This is a vector of all order structs that we have allocated. */
        Vector<Order *> allOrders;
 
+       HashsetOrder activeOrders;
+
        /** This is a vector of all function structs that we have allocated. */
        Vector<Function *> allFunctions;
 
+       BooleanEdge boolTrue;
+       BooleanEdge boolFalse;
+
+       /** These two tables are used for deduplicating entries. */
+       BooleanMatchMap boolMap;
+       ElementMatchMap elemMap;
+
        SATEncoder *satEncoder;
        bool unsat;
+       bool booleanVarUsed;
+       bool incrementalMode;
+       bool optimizationsOff;
        Tuner *tuner;
-
        long long elapsedTime;
+       long satsolverTimeout;
+       Interpreter *interpreter;
+       bool noOptimization;
+       friend class ElementOpt;
+       friend class VarOrderingOpt;
 };
+
+inline CompOp flipOp(CompOp op) {
+       switch (op) {
+       case SATC_EQUALS:
+               return SATC_EQUALS;
+       case SATC_LT:
+               return SATC_GT;
+       case SATC_GT:
+               return SATC_LT;
+       case SATC_LTE:
+               return SATC_GTE;
+       case SATC_GTE:
+               return SATC_LTE;
+       }
+       ASSERT(0);
+}
+
+inline CompOp negateOp(CompOp op) {
+       switch (op) {
+       case SATC_EQUALS:
+               ASSERT(0);
+       case SATC_LT:
+               return SATC_GTE;
+       case SATC_GT:
+               return SATC_LTE;
+       case SATC_LTE:
+               return SATC_GT;
+       case SATC_GTE:
+               return SATC_LT;
+       }
+       ASSERT(0);
+}
 #endif