documentation

[c11tester.git] / cyclegraph.cc

diff --git a/cyclegraph.cc b/cyclegraph.cc
index c1fea4f3d0a96f14de433b6aac8b61e6f6479131..750086c5c1c37fa63ab18072a5a2a7d94b504879 100644 (file)
--- a/cyclegraph.cc
+++ b/cyclegraph.cc
@@ -1,9 +1,14 @@
 #include "cyclegraph.h"
+#include "action.h"
+
+/** Initializes a CycleGraph object. */
 
 CycleGraph::CycleGraph() {
        hasCycles=false;
 }
 
+/** Returns the CycleNode for a given ModelAction. */
+
 CycleNode * CycleGraph::getNode(ModelAction * action) {
        CycleNode *node=actionToNode.get(action);
        if (node==NULL) {
@@ -13,6 +18,8 @@ CycleNode * CycleGraph::getNode(ModelAction * action) {
        return node;
 }
 
+/** Adds an edge between two ModelActions. */
+
 void CycleGraph::addEdge(ModelAction *from, ModelAction *to) {
        CycleNode *fromnode=getNode(from);
        CycleNode *tonode=getNode(to);
@@ -23,18 +30,20 @@ void CycleGraph::addEdge(ModelAction *from, ModelAction *to) {
        fromnode->addEdge(tonode);
 }
 
+/** Checks whether the first CycleNode can reach the second one. */
+
 bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
-       std::vector<class CycleNode *> queue;
-       HashTable<class CycleNode *, class CycleNode *, uintptr_t, 4> discovered;
-       
+       std::vector<CycleNode *> queue;
+       HashTable<CycleNode *, CycleNode *, uintptr_t, 4> discovered;
+
        queue.push_back(from);
        discovered.put(from, from);
        while(!queue.empty()) {
-               class CycleNode * node=queue.back();
+               CycleNode * node=queue.back();
                queue.pop_back();
                if (node==to)
                        return true;
-               
+
                for(unsigned int i=0;i<node->getEdges()->size();i++) {
                        CycleNode *next=(*node->getEdges())[i];
                        if (!discovered.contains(next)) {
@@ -46,14 +55,25 @@ bool CycleGraph::checkReachable(CycleNode *from, CycleNode *to) {
        return false;
 }
 
+/** Returns whether a CycleGraph contains cycles. */
+bool checkForCycles() {
+       return hasCycles;
+}
+
+/** Constructor for a CycleNode. */
+
 CycleNode::CycleNode(ModelAction *modelaction) {
        action=modelaction;
 }
 
-std::vector<class CycleNode *> * CycleNode::getEdges() {
+/** Returns a vector of the edges from a CycleNode. */
+
+std::vector<CycleNode *> * CycleNode::getEdges() {
        return &edges;
 }
 
+/** Adds an edge to a CycleNode. */
+
 void CycleNode::addEdge(CycleNode * node) {
        edges.push_back(node);
 }