Small edit
[satune.git] / src / csolver.h
index 1d398ce9b4736aaeab384232258da29f9e9ae35f..79428395dcdfe5372277ff6ae9787438d2f94c8c 100644 (file)
 #ifndef CSOLVER_H
 #define CSOLVER_H
-#include "classlist.h"
+#include "classes.h"
 #include "ops.h"
+#include "corestructs.h"
+#include "asthash.h"
+#include "solver_interface.h"
 
 class CSolver {
 public:
        CSolver();
+       ~CSolver();
 
-       Set * createSet(Type type, uint64_t ** elements);
-       Set * createSet(Type type, uint64_t lowrange, uint64_t highrange);
-       MutableSet * createMutableSet(Type type);
+       /** This function creates a set containing the elements passed in the array. */
+       Set *createSet(VarType type, uint64_t *elements, uint num);
 
-       void addItem(MutableSet * set, uint64_t element);
-       int64_t createUniqueItem(MutableSet * set);
+       /** This function creates a set from lowrange to highrange (inclusive). */
 
-       Element * getElementVar(Set * set);
-       Constraint * getBooleanVar();
+       Set *createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange);
 
-       Function * createFunctionOperator(enum ArithOp op, Set ** domain, Set * range, enum OverFlowBehavior overflowbehavior, Constraint * overflowstatus);
-       Function * createFunctionOperator(enum ArithOp op);                                                                                                                                                                                                                                                                                                                                                                                                                                                                             //Does Not Overflow
-       Predicate * createPredicateOperator(enum CompOp op, Set ** domain);
+       Element *createRangeVar(VarType type, uint64_t lowrange, uint64_t highrange);
+               
+       /** This function creates a mutable set. */
 
-       Table * createTable(Set **domains, Set * range);
-       void addTableEntry(Element ** inputs, Element *result);
-       Function * completeTable(struct Table *);
+       MutableSet *createMutableSet(VarType type);
 
-       Element * applyFunction(Function * function, Element ** array);
-       Constraint * applyPredicate(Predicate * predicate, Element ** inputs);
-       Constraint * applyLogicalOperation(enum LogicOp op, Constraint ** array);
+       /** This function adds a new item to a set. */
 
-       void addConstraint(Constraint * constraint);
+       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);
+
+       Boolean *getBooleanTrue();
+
+       Boolean *getBooleanFalse();
+       
+       /** This function creates a boolean variable. */
+
+       Boolean *getBooleanVar(VarType type);
+
+       /** This function creates a function operator. */
+
+       Function *createFunctionOperator(ArithOp op, Set **domain, uint numDomain, Set *range,
+                                                                                                                                        OverFlowBehavior overflowbehavior);
+
+       /** This function creates a predicate operator. */
+
+       Predicate *createPredicateOperator(CompOp op, Set **domain, uint numDomain);
+
+       Predicate *createPredicateTable(Table *table, UndefinedBehavior behavior);
+
+       /** This function creates an empty instance table.*/
+
+       Table *createTable(Set **domains, uint numDomain, Set *range);
+
+       Table *createTableForPredicate(Set **domains, uint numDomain);
+       /** This function adds an input output relation to a table. */
+
+       void addTableEntry(Table *table, uint64_t *inputs, uint inputSize, uint64_t result);
+
+       /** This function converts a completed table into a function. */
+
+       Function *completeTable(Table *, UndefinedBehavior behavior);
+
+       /** This function applies a function to the Elements in its input. */
+
+       Element *applyFunction(Function *function, Element **array, uint numArrays, Boolean *overflowstatus);
+
+       /** This function applies a predicate to the Elements in its input. */
+
+       Boolean *applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, Boolean *undefinedStatus);
+
+       Boolean *applyPredicate(Predicate *predicate, Element **inputs, uint numInputs);
+
+       /** This function applies a logical operation to the Booleans in its input. */
+
+       Boolean *applyLogicalOperation(LogicOp op, Boolean **array, uint asize);
+
+               /** This function applies a logical operation to the Booleans in its input. */
+
+       Boolean *applyLogicalOperation(LogicOp op, Boolean * arg1, Boolean * arg2);
+
+       /** This function applies a logical operation to the Booleans in its input. */
+
+       Boolean *applyLogicalOperation(LogicOp op, Boolean *arg);
+
+       /** This function adds a boolean constraint to the set of constraints
+           to be satisfied */
+
+       void addConstraint(Boolean *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);
+
+       /** When everything is done, the client calls this function and then csolver starts to encode*/
+       int solve();
+
+       /** After getting the solution from the SAT solver, client can get the value of an element via this function*/
+       uint64_t getElementValue(Element *element);
+
+       /** After getting the solution from the SAT solver, client can get the value of a boolean via this function*/
+       bool getBooleanValue(Boolean *boolean);
+
+       HappenedBefore getOrderConstraintValue(Order *order, uint64_t first, uint64_t second);
+
+       bool isTrue(Boolean *b);
+       bool isFalse(Boolean *b);
+       
+       void setUnSAT() { unsat = true; }
+
+       bool isUnSAT() { return unsat; }
+
+       Vector<Order *> *getOrders() { return &allOrders;}
+
+       Tuner *getTuner() { return tuner; }
+       Transformer* getTransformer() {return transformer;}
+       
+       SetIteratorBoolean *getConstraints() { return constraints.iterator(); }
+
+       SATEncoder *getSATEncoder() {return satEncoder;}
+
+       void replaceBooleanWithTrue(Boolean *bexpr);
+       void replaceBooleanWithFalse(Boolean *bexpr);
+       void replaceBooleanWithBoolean(Boolean *oldb, Boolean *newb);
+       CSolver *clone();
+       void autoTune(uint budget);
+
+       void setTransformer(Transformer * _transformer) {  transformer = _transformer; }
+       void setTuner(Tuner * _tuner) { tuner = _tuner; }
+       long long getElapsedTime() { return elapsedTime; }
+       long long getEncodeTime();
+       long long getSolveTime();
+       
+       CMEMALLOC;
 
-       Order * createOrder(enum OrderType type, Set * set);
-       Constraint * orderedConstraint(Order * order, uint64_t first, uint64_t second);
 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);
+
+       /** This is a vector of constraints that must be satisfied. */
+       HashsetBoolean constraints;
+
+       /** 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;
+
+       /** This is a vector of all function structs that we have allocated. */
+       Vector<Function *> allFunctions;
 
+       Boolean * boolTrue;
+       Boolean * boolFalse;
+       
+       /** These two tables are used for deduplicating entries. */
+       BooleanMatchMap boolMap;
+       ElementMatchMap elemMap;
+       
+       SATEncoder *satEncoder;
+       bool unsat;
+       Tuner *tuner;
+       Transformer* transformer;
+       long long elapsedTime;
 };
 #endif