Adding API for AtMostOneConstraint + bugfix for turning off the optimizations
[satune.git] / src / csolver.h
index fa2ee1426fad6288162bc880ef7c1fdd72dd03d5..5ef235d3d8ce9b26032380b30c4cea82c85bd0f2 100644 (file)
@@ -18,17 +18,17 @@ public:
        /** This function creates a set from lowrange to highrange (inclusive). */
 
        Set *createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange);
-        
-        bool itemExistInSet(Set *set, uint64_t item);
+
+       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!
-         */
+        * Note: You should use addItem for adding new item to Mutable sets, and
+        * at the end, you should call finalizeMutableSet!
+        */
 
        MutableSet *createMutableSet(VarType type);
 
@@ -57,8 +57,8 @@ public:
 
        Set *getElementRange (Element *element);
 
-        void mustHaveValue(Element *element);
-        
+       void mustHaveValue(Element *element);
+
        BooleanEdge getBooleanTrue();
 
        BooleanEdge getBooleanFalse();
@@ -69,20 +69,20 @@ public:
 
        /** 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);
@@ -101,6 +101,12 @@ public:
 
        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. */
 
        BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge *array, uint asize);
@@ -126,10 +132,19 @@ public:
 
        /** When everything is done, the client calls this function and then csolver starts to encode*/
        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(BooleanEdge boolean);
 
@@ -139,8 +154,9 @@ public:
        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();
 
@@ -150,6 +166,8 @@ public:
        Tuner *getTuner() { return tuner; }
 
        SetIteratorBooleanEdge *getConstraints() { return constraints.iterator(); }
+       bool isConstraintEncoded(BooleanEdge be) { return encodedConstraints.contains(be);}
+       void addEncodedConstraint(BooleanEdge be) {encodedConstraints.add(be);}
 
        SATEncoder *getSATEncoder() {return satEncoder;}
 
@@ -159,24 +177,26 @@ public:
        void replaceBooleanWithFalse(BooleanEdge bexpr);
        void replaceBooleanWithBoolean(BooleanEdge oldb, BooleanEdge newb);
        CSolver *clone();
-//        Set* addItemsToRange(Element* element, uint num, ...);
        void serialize();
-       static CSolver *deserialize(const char *file);
+       static CSolver *deserialize(const char *file, InterpreterType itype = SATUNE);
        void autoTune(uint budget);
        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();
-
+       long getSatSolverTimeout() { return satsolverTimeout;}
+       bool isIncrementalMode() {return incrementalMode;}
+       void freezeElementsVariables();
        CMEMALLOC;
 
 private:
        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
@@ -184,6 +204,7 @@ private:
        BooleanEdge doRewrite(BooleanEdge b);
        /** This is a vector of constraints that must be satisfied. */
        HashsetBooleanEdge constraints;
+       HashsetBooleanEdge encodedConstraints;
 
        /** This is a vector of all boolean structs that we have allocated. */
        Vector<Boolean *> allBooleans;
@@ -217,7 +238,47 @@ private:
 
        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