really should be using a type that is big enough for all commonly used data types...

[cdsspec-compiler.git] / nodestack.h

diff --git a/nodestack.h b/nodestack.h
index 974f1a94ad10cefbf59d62b89575de5595879c84..11cbdfa801d772d70e210668db374fd71f718b71 100644 (file)
--- a/nodestack.h
+++ b/nodestack.h
@@ -7,15 +7,23 @@
 
 #include <list>
 #include <vector>
-#include <set>
 #include <cstddef>
 #include "threads.h"
 #include "mymemory.h"
 
 class ModelAction;
 
-typedef std::set< ModelAction *, std::less< ModelAction *>, MyAlloc< ModelAction * > > action_set_t;
-
+typedef std::list< const ModelAction *, MyAlloc< const ModelAction * > > readfrom_set_t;
+
+/**
+ * @brief A single node in a NodeStack
+ *
+ * Represents a single node in the NodeStack. Each Node is associated with up
+ * to one action and up to one parent node. A node holds information
+ * regarding the last action performed (the "associated action"), the thread
+ * choices that have been explored (explored_children) and should be explored
+ * (backtrack), and the actions that the last action may read from.
+ */
 class Node {
 public:
        Node(ModelAction *act = NULL, Node *par = NULL, int nthreads = 1);
@@ -35,9 +43,11 @@ public:
         * occurred previously in the stack. */
        Node * get_parent() const { return parent; }
 
-       void add_read_from(ModelAction *act);
+       void add_read_from(const ModelAction *act);
+       const ModelAction * get_next_read_from();
 
        void print();
+       void print_may_read_from();
 
        MEMALLOC
 private:
@@ -52,11 +62,19 @@ private:
 
        /** The set of ModelActions that this the action at this Node may read
         *  from. Only meaningful if this Node represents a 'read' action. */
-       action_set_t *may_read_from;
+       readfrom_set_t may_read_from;
 };
 
-typedef std::list<class Node *, MyAlloc< class Node * > > node_list_t;
+typedef std::list< Node *, MyAlloc< Node * > > node_list_t;
 
+/**
+ * @brief A stack of nodes
+ *
+ * Holds a Node linked-list that can be used for holding backtracking,
+ * may-read-from, and replay information. It is used primarily as a
+ * stack-like structure, in that backtracking points and replay nodes are
+ * only removed from the top (most recent).
+ */
 class NodeStack {
 public:
        NodeStack();