[Lemon-commits] [lemon_svn] marci: r734 - in hugo/trunk: doc src/hugo

[Lemon SVN]

Author: marci
Date: Thu May  6 21:01:00 2004
New Revision: 734

Modified:
   hugo/trunk/doc/Doxyfile
   hugo/trunk/src/hugo/graph_wrapper.h

Log:


Modified: hugo/trunk/doc/Doxyfile
==============================================================================
--- hugo/trunk/doc/Doxyfile	(original)
+++ hugo/trunk/doc/Doxyfile	Thu May  6 21:01:00 2004
@@ -399,7 +399,6 @@
                          ../src/work/alpar/list_graph.h \
                          ../src/work/athos/minlengthpaths.h \
                          ../src/work/klao/path.h \
-			 ../src/work/marci/graph_wrapper.h \
                          ../src/work/jacint/max_flow.h
 
 # If the value of the INPUT tag contains directories, you can use the 

Modified: hugo/trunk/src/hugo/graph_wrapper.h
==============================================================================
--- hugo/trunk/src/hugo/graph_wrapper.h	(original)
+++ hugo/trunk/src/hugo/graph_wrapper.h	Thu May  6 21:01:00 2004
@@ -436,26 +436,31 @@
     Node bNode(const InEdgeIt& e) const { 
       return Node(this->graph->bNode(e.e)); }
 
-    ///\todo
-    ///Some doki, please.
+    /// This function hides \c n in the graph, i.e. the iteration 
+    /// jumps over it. This is done by simply setting the value of \c n  
+    /// to be false in the corresponding node-map.
     void hide(const Node& n) const { node_filter_map->set(n, false); }
-    ///\todo
-    ///Some doki, please.
+
+    /// This function hides \c e in the graph, i.e. the iteration 
+    /// jumps over it. This is done by simply setting the value of \c e  
+    /// to be false in the corresponding edge-map.
     void hide(const Edge& e) const { edge_filter_map->set(e, false); }
 
-    ///\todo
-    ///Some doki, please.
-    void unHide(const Node& n) const { node_filter_map->set(n, true); }
-    ///\todo
-    ///Some doki, please.
+    /// The value of \c n is set to be true in the node-map which stores 
+    /// hide information. If \c n was hidden previuosly, then it is shown 
+    /// again
+     void unHide(const Node& n) const { node_filter_map->set(n, true); }
+
+    /// The value of \c e is set to be true in the edge-map which stores 
+    /// hide information. If \c e was hidden previuosly, then it is shown 
+    /// again
     void unHide(const Edge& e) const { edge_filter_map->set(e, true); }
 
-    ///\todo
-    ///Some doki, please.
-    bool hidden(const Node& n) const { return (*node_filter_map)[n]; }
-    ///\todo
-    ///Some doki, please.
-    bool hidden(const Edge& e) const { return (*edge_filter_map)[e]; }
+    /// Returns true if \c n is hidden.
+    bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
+
+    /// Returns true if \c n is hidden.
+    bool hidden(const Edge& e) const { return !(*edge_filter_map)[e]; }
   };
 
   /// A wrapper for forgetting the orientation of a graph.