nodestack: turn magic promise numbers into enum + typedef

[model-checker.git] / cyclegraph.h

diff --git a/cyclegraph.h b/cyclegraph.h
index 5cf709324a863d51e4ec45956093600460495232..2e523d7950b28c5b91830217414eebbc459d2972 100644 (file)
--- a/cyclegraph.h
+++ b/cyclegraph.h
@@ -19,15 +19,23 @@ class CycleGraph {
        ~CycleGraph();
        void addEdge(const ModelAction *from, const ModelAction *to);
        bool checkForCycles();
-       void addRMWEdge(const ModelAction *from, const ModelAction *to);
+       void addRMWEdge(const ModelAction *from, const ModelAction *rmw);
+
+       bool checkReachable(const ModelAction *from, const ModelAction *to);
 
  private:
        CycleNode * getNode(const ModelAction *);
+
+       /** @brief A table for mapping ModelActions to CycleNodes */
        HashTable<const ModelAction *, CycleNode *, uintptr_t, 4> actionToNode;
+
        bool checkReachable(CycleNode *from, CycleNode *to);
+
+       /** @brief A flag: true if this graph contains cycles */
        bool hasCycles;
 };
 
+/** @brief A node within a CycleGraph; corresponds to one ModelAction */
 class CycleNode {
  public:
        CycleNode(const ModelAction *action);
@@ -37,8 +45,14 @@ class CycleNode {
        CycleNode* getRMW();
 
  private:
+       /** @brief The ModelAction that this node represents */
        const ModelAction *action;
+
+       /** @brief The edges leading out from this node */
        std::vector<CycleNode *> edges;
+
+       /** Pointer to a RMW node that reads from this node, or NULL, if none
+        * exists */
        CycleNode * hasRMW;
 };