Merge branch 'master' into brian

[satune.git] / src / csolver.h

diff --git a/src/csolver.h b/src/csolver.h
index f2db838c409b7aa0557b941847a9c56421570cd0..bd90bf3054a5cbf85e4b506097391c2786e51d7d 100644 (file)
--- a/src/csolver.h
+++ b/src/csolver.h
@@ -5,36 +5,113 @@
 #include "structs.h"
 
 struct CSolver {
-       VectorBoolean * constraint;
-        uint64_t uniqSec;
+       /** This is a vector of constraints that must be satisfied. */
+       VectorBoolean * constraints;
+
+       /** This is a vector of all boolean structs that we have allocated. */
+       VectorBoolean * allBooleans;
+
+       /** This is a vector of all set structs that we have allocated. */
+       VectorSet * allSets;
+
+       /** This is a vector of all element structs that we have allocated. */
+       VectorElement * allElements;
+
+       /** This is a vector of all predicate structs that we have allocated. */
+       VectorPredicate * allPredicates;
+
+       /** This is a vector of all table structs that we have allocated. */
+       VectorTable * allTables;
+
+       /** This is a vector of all order structs that we have allocated. */
+       VectorOrder * allOrders;
+
+       /** This is a vector of all function structs that we have allocated. */
+       VectorFunction* allFunctions;
 };
-       
+
+/** Create a new solver instance. */
+
 CSolver * allocCSolver();
+
+/** Delete solver instance. */
+
+void deleteSolver(CSolver * This);
+
+/** This function creates a set containing the elements passed in the array. */
+
 Set * createSet(CSolver *, VarType type, uint64_t * elements, uint num);
+
+/** This function creates a set from lowrange to highrange (inclusive). */
+
 Set * createRangeSet(CSolver *, VarType type, uint64_t lowrange, uint64_t highrange);
+
+/** This function creates a mutable set. */
+
 MutableSet * createMutableSet(CSolver *, VarType type);
 
+/** This function adds a new item to a set. */
+
 void addItem(CSolver *, MutableSet * set, uint64_t element);
-int64_t createUniqueItem(CSolver *, MutableSet * set);
+
+/** 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(CSolver *, MutableSet * set);
+
+/** This function creates an element variable over a set. */
 
 Element * getElementVar(CSolver *, Set * set);
-Boolean * getBooleanVar(CSolver *);
 
-Function * createFunctionOperator(CSolver *, enum ArithOp op, Set ** domain, Set * range, enum OverFlowBehavior overflowbehavior, Boolean * overflowstatus);
-//Does Not Overflow
-Function * createFunctionOperatorPure(CSolver *, enum ArithOp op);
-Predicate * createPredicateOperator(CSolver *, enum CompOp op, Set ** domain);
+/** This function creates a boolean variable. */
+
+Boolean * getBooleanVar(CSolver *, VarType type);
+
+/** This function creates a function operator. */
+
+Function * createFunctionOperator(CSolver *solver, ArithOp op, Set ** domain, uint numDomain, Set * range,
+                                                                                                                                       OverFlowBehavior overflowbehavior);
+
+/** This function creates a predicate operator. */
+
+Predicate * createPredicateOperator(CSolver *solver, CompOp op, Set ** domain, uint numDomain);
+
+/** This function creates an empty instance table.*/
+
+Table * createTable(CSolver *solver, Set **domains, uint numDomain, Set * range);
+
+/** This function adds an input output relation to a table. */
+
+void addTableEntry(CSolver *solver, Table* table, uint64_t* inputs, uint inputSize, uint64_t result);
 
-Table * createTable(CSolver *, Set **domains, Set * range);
-void addTableEntry(CSolver *, Element ** inputs, Element *result);
-Function * completeTable(CSolver *, struct Table *);
+/** This function converts a completed table into a function. */
 
-Element * applyFunction(CSolver *, Function * function, Element ** array);
-Boolean * applyPredicate(CSolver *, Predicate * predicate, Element ** inputs);
-Boolean * applyLogicalOperation(CSolver *, enum LogicOp op, Boolean ** array);
+Function * completeTable(CSolver *, Table *);
+
+/** This function applies a function to the Elements in its input. */
+
+Element * applyFunction(CSolver *, Function * function, Element ** array, uint numArrays, Boolean * overflowstatus);
+
+/** This function applies a predicate to the Elements in its input. */
+
+Boolean * applyPredicate(CSolver *, Predicate * predicate, Element ** inputs, uint numInputs);
+
+/** This function applies a logical operation to the Booleans in its input. */
+
+Boolean * applyLogicalOperation(CSolver *, LogicOp op, Boolean ** array, uint asize);
+
+/** This function adds a boolean constraint to the set of constraints
+    to be satisfied */
 
 void addBoolean(CSolver *, Boolean * constraint);
 
-Order * createOrder(CSolver *, enum OrderType type, Set * set);
+/** This function instantiates an order of type type over the set set. */
+Order * createOrder(CSolver *, OrderType type, Set * set);
+
+/** This function instantiates a boolean on two items in an order. */
 Boolean * orderConstraint(CSolver *, Order * order, uint64_t first, uint64_t second);
+
+/** When everything is done, the client calls this function and then csolver starts to encode*/
+void startEncoding(CSolver*);
 #endif