Remove unimplemented enum
[satune.git] / src / csolver.h
index 2a3fea0332de425893522cee00255e7c2ff6e5ce..b53b77ba9b9b6ffd565aa1698bc43999cc4f3ffc 100644 (file)
 #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"
 
-struct CSolver {
-       SATEncoder* satEncoder;
-       /** This is a vector of constraints that must be satisfied. */
-       VectorBoolean * constraints;
+class CSolver {
+public:
+       CSolver();
+       ~CSolver();
 
-       /** This is a vector of all boolean structs that we have allocated. */
-       VectorBoolean * allBooleans;
+       /** This function creates a set containing the elements passed in the array. */
+       Set *createSet(VarType type, uint64_t *elements, uint num);
 
-       /** This is a vector of all set structs that we have allocated. */
-       VectorSet * allSets;
+       /** This function creates a set from lowrange to highrange (inclusive). */
 
-       /** This is a vector of all element structs that we have allocated. */
-       VectorElement * allElements;
+       Set *createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange);
 
-       /** This is a vector of all predicate structs that we have allocated. */
-       VectorPredicate * allPredicates;
+       Element *createRangeVar(VarType type, uint64_t lowrange, uint64_t highrange);
 
-       /** This is a vector of all table structs that we have allocated. */
-       VectorTable * allTables;
+       /** This function creates a mutable set. */
 
-       /** This is a vector of all order structs that we have allocated. */
-       VectorOrder * allOrders;
+       MutableSet *createMutableSet(VarType type);
 
-       /** This is a vector of all function structs that we have allocated. */
-       VectorFunction* allFunctions;
-};
+       /** This function adds a new item to a set. */
+
+       void addItem(MutableSet *set, uint64_t element);
+
+       /** This function adds a new unique item to the set and returns it.
+           This function cannot be used in conjunction with manually adding
+           items to the set. */
+
+       uint64_t createUniqueItem(MutableSet *set);
+
+       /** This function creates an element variable over a set. */
+
+       Element *getElementVar(Set *set);
+
+       /** This function creates an element constrant. */
+       Element *getElementConst(VarType type, uint64_t value);
+
+       BooleanEdge getBooleanTrue();
+
+       BooleanEdge getBooleanFalse();
 
-/** Create a new solver instance. */
+       /** This function creates a boolean variable. */
 
-CSolver * allocCSolver();
+       BooleanEdge getBooleanVar(VarType type);
 
-/** Delete solver instance. */
+       /** This function creates a function operator. */
 
-void deleteSolver(CSolver * This);
+       Function *createFunctionOperator(ArithOp op, Set **domain, uint numDomain, Set *range,
+                                                                                                                                        OverFlowBehavior overflowbehavior);
 
-/** This function creates a set containing the elements passed in the array. */
+       /** This function creates a predicate operator. */
 
-Set * createSet(CSolver *, VarType type, uint64_t * elements, uint num);
+       Predicate *createPredicateOperator(CompOp op, Set **domain, uint numDomain);
 
-/** This function creates a set from lowrange to highrange (inclusive). */
+       Predicate *createPredicateTable(Table *table, UndefinedBehavior behavior);
 
-Set * createRangeSet(CSolver *, VarType type, uint64_t lowrange, uint64_t highrange);
+       /** This function creates an empty instance table.*/
 
-/** This function creates a mutable set. */
+       Table *createTable(Set **domains, uint numDomain, Set *range);
 
-MutableSet * createMutableSet(CSolver *, VarType type);
+       Table *createTableForPredicate(Set **domains, uint numDomain);
+       /** This function adds an input output relation to a table. */
 
-/** This function adds a new item to a set. */
+       void addTableEntry(Table *table, uint64_t *inputs, uint inputSize, uint64_t result);
 
-void addItem(CSolver *, MutableSet * set, uint64_t element);
+       /** This function converts a completed table into a function. */
 
-/** This function adds a new unique item to the set and returns it.
-    This function cannot be used in conjunction with manually adding
-    items to the set. */
+       Function *completeTable(Table *, UndefinedBehavior behavior);
 
-uint64_t createUniqueItem(CSolver *, MutableSet * set);
+       /** This function applies a function to the Elements in its input. */
 
-/** This function creates an element variable over a set. */
+       Element *applyFunction(Function *function, Element **array, uint numArrays, BooleanEdge overflowstatus);
 
-Element * getElementVar(CSolver *, Set * set);
+       /** This function applies a predicate to the Elements in its input. */
 
-/** This function creates an element constrant. */
-Element * getElementConst(CSolver *, VarType type, uint64_t value);
+       BooleanEdge applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, BooleanEdge undefinedStatus);
 
-/** This function creates a boolean variable. */
+       BooleanEdge applyPredicate(Predicate *predicate, Element **inputs, uint numInputs);
 
-Boolean * getBooleanVar(CSolver *, VarType type);
+       /** This function applies a logical operation to the Booleans in its input. */
 
-/** This function creates a function operator. */
+       BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge *array, uint asize);
 
-Function * createFunctionOperator(CSolver *solver, ArithOp op, Set ** domain, uint numDomain, Set * range,
-                                                                                                                                       OverFlowBehavior overflowbehavior);
+       /** This function applies a logical operation to the Booleans in its input. */
 
-/** This function creates a predicate operator. */
+       BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge arg1, BooleanEdge arg2);
 
-Predicate * createPredicateOperator(CSolver *solver, CompOp op, Set ** domain, uint numDomain);
+       /** This function applies a logical operation to the Booleans in its input. */
 
-Predicate * createPredicateTable(CSolver *solver, Table* table, UndefinedBehavior behavior);
+       BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge arg);
 
-/** This function creates an empty instance table.*/
+       /** This function adds a boolean constraint to the set of constraints
+           to be satisfied */
 
-Table * createTable(CSolver *solver, Set **domains, uint numDomain, Set * range);
+       void addConstraint(BooleanEdge constraint);
 
-Table * createTablePredicate(CSolver *solver, Set **domains, uint numDomain);
+       /** This function instantiates an order of type type over the set set. */
+       Order *createOrder(OrderType type, Set *set);
 
-/** This function adds an input output relation to a table. */
+       /** This function instantiates a boolean on two items in an order. */
+       BooleanEdge orderConstraint(Order *order, uint64_t first, uint64_t second);
 
-void addTableEntry(CSolver *solver, Table* table, uint64_t* inputs, uint inputSize, uint64_t result);
+       /** When everything is done, the client calls this function and then csolver starts to encode*/
+       int solve();
 
-/** This function converts a completed table into a function. */
+       /** After getting the solution from the SAT solver, client can get the value of an element via this function*/
+       uint64_t getElementValue(Element *element);
 
-Function * completeTable(CSolver *, Table *, UndefinedBehavior behavior);
+       /** After getting the solution from the SAT solver, client can get the value of a boolean via this function*/
+       bool getBooleanValue(BooleanEdge boolean);
 
-/** This function applies a function to the Elements in its input. */
+       bool getOrderConstraintValue(Order *order, uint64_t first, uint64_t second);
 
-Element * applyFunction(CSolver *, Function * function, Element ** array, uint numArrays, Boolean * overflowstatus);
+       bool isTrue(BooleanEdge b);
+       bool isFalse(BooleanEdge b);
 
-/** This function applies a predicate to the Elements in its input. */
+       void setUnSAT() { unsat = true; }
 
-Boolean * applyPredicate(CSolver *, Predicate * predicate, Element ** inputs, uint numInputs, Boolean* undefinedStatus);
+       bool isUnSAT() { return unsat; }
 
-/** This function applies a logical operation to the Booleans in its input. */
+       Vector<Order *> *getOrders() { return &allOrders;}
+       HashsetOrder * getActiveOrders() { return &activeOrders;}
 
-Boolean * applyLogicalOperation(CSolver *, LogicOp op, Boolean ** array, uint asize);
+       Tuner *getTuner() { return tuner; }
 
-/** This function adds a boolean constraint to the set of constraints
-    to be satisfied */
+       SetIteratorBooleanEdge * getConstraints() { return constraints.iterator(); }
 
-void addConstraint(CSolver *, Boolean * constraint);
+       SATEncoder *getSATEncoder() {return satEncoder;}
 
-/** This function instantiates an order of type type over the set set. */
-Order * createOrder(CSolver *, OrderType type, Set * set);
+       void replaceBooleanWithTrue(BooleanEdge bexpr);
+       void replaceBooleanWithTrueNoRemove(BooleanEdge bexpr);
+       void replaceBooleanWithFalse(BooleanEdge bexpr);
+       void replaceBooleanWithBoolean(BooleanEdge oldb, BooleanEdge newb);
+       CSolver *clone();
+       void autoTune(uint budget);
 
-/** This function instantiates a boolean on two items in an order. */
-Boolean * orderConstraint(CSolver *, Order * order, uint64_t first, uint64_t second);
+       void setTuner(Tuner *_tuner) { tuner = _tuner; }
+       long long getElapsedTime() { return elapsedTime; }
+       long long getEncodeTime();
+       long long getSolveTime();
 
-/** When everything is done, the client calls this function and then csolver starts to encode*/
-int startEncoding(CSolver*);
+       CMEMALLOC;
 
-/** After getting the solution from the SAT solver, client can get the value of an element via this function*/
-uint64_t getElementValue(CSolver*, Element* element);
+private:
+       void handleIFFTrue(BooleanLogic *bexpr, BooleanEdge child);
+       void handleANDTrue(BooleanLogic *bexpr, BooleanEdge child);
 
-/** After getting the solution from the SAT solver, client can get the value of a boolean via this function*/
-bool getBooleanValue( CSolver* , Boolean* boolean);
+       //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. */
+       HashsetBooleanEdge constraints;
 
-HappenedBefore getOrderConstraintValue(CSolver*, Order * order, uint64_t first, uint64_t second);
+       /** This is a vector of all boolean structs that we have allocated. */
+       Vector<Boolean *> allBooleans;
 
+       /** This is a vector of all set structs that we have allocated. */
+       Vector<Set *> allSets;
+
+       /** This is a vector of all element structs that we have allocated. */
+       Vector<Element *> allElements;
+
+       /** This is a vector of all predicate structs that we have allocated. */
+       Vector<Predicate *> allPredicates;
+
+       /** This is a vector of all table structs that we have allocated. */
+       Vector<Table *> allTables;
+
+       /** 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;
+       Tuner *tuner;
+       long long elapsedTime;
+};
 #endif