Changeset 2084:59769591eb60 in lemon-0.x for lemon/ugraph_adaptor.h

Timestamp:

05/15/06 11:49:51 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2749

Message:

Documentation improvements

Rearrangements:

IO modules
Algorithms

New documentation:

SwapBpUGraphAdaptor

Demos:

strongly_connected_orientation.cc

Benchmarks:

swap_bipartite_bench.cc

File:

• lemon/ugraph_adaptor.h (modified) (9 diffs)

lemon/ugraph_adaptor.h

@@ -39 +39 @@
 namespace lemon {
 
-  /// \ingroup graph_adaptors
-  ///
   /// \brief Base type for the Graph Adaptors
   ///
@@ -234 +232 @@
 
   /// \ingroup graph_adaptors
+  ///
+  /// \brief Trivial undirected graph adaptor
+  ///
+  /// This class is an adaptor which does not change the adapted undirected
+  /// graph. It can be used only to test the undirected graph adaptors.
   template <typename _UGraph>
   class UGraphAdaptor 
@@ -349 +352 @@
     }
 
-    ///\e
-
+    /// \brief Hide the given node in the graph.
+    ///
     /// 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  
@@ -356 +359 @@
     void hide(const Node& n) const { node_filter_map->set(n, false); }
 
-    ///\e
-
+    /// \brief Hide the given undirected edge in the graph.
+    ///
     /// 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.
+    /// to be false in the corresponding uedge-map.
     void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
 
-    ///\e
-
+    /// \brief Unhide the given node in the graph.
+    ///
     /// 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 
@@ -370 +373 @@
      void unHide(const Node& n) const { node_filter_map->set(n, true); }
 
-    ///\e
-
-    /// The value of \c e is set to be true in the edge-map which stores 
+    /// \brief Hide the given undirected edge in the graph.
+    ///
+    /// The value of \c e is set to be true in the uedge-map which stores 
     /// hide information. If \c e was hidden previuosly, then it is shown 
     /// again
     void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
 
+    /// \brief Returns true if \c n is hidden.
+    ///
     /// Returns true if \c n is hidden.
-    
-    ///\e
-    ///
     bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
 
-    /// Returns true if \c n is hidden.
-    
-    ///\e
-    ///
+    /// \brief Returns true if \c e is hidden.
+    ///
+    /// Returns true if \c e is hidden.
     bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
 
@@ -578 +579 @@
     }
 
-    ///\e
-
+    /// \brief Hide the given node in the graph.
+    ///
     /// 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  
@@ -585 +586 @@
     void hide(const Node& n) const { node_filter_map->set(n, false); }
 
-    ///\e
-
+    /// \brief Hide the given undirected edge in the graph.
+    ///
     /// 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.
+    /// to be false in the corresponding uedge-map.
     void hide(const UEdge& e) const { uedge_filter_map->set(e, false); }
 
-    ///\e
-
+    /// \brief Unhide the given node in the graph.
+    ///
     /// 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 
@@ -599 +600 @@
      void unHide(const Node& n) const { node_filter_map->set(n, true); }
 
-    ///\e
-
-    /// The value of \c e is set to be true in the edge-map which stores 
+    /// \brief Hide the given undirected edge in the graph.
+    ///
+    /// The value of \c e is set to be true in the uedge-map which stores 
     /// hide information. If \c e was hidden previuosly, then it is shown 
     /// again
     void unHide(const UEdge& e) const { uedge_filter_map->set(e, true); }
 
+    /// \brief Returns true if \c n is hidden.
+    ///
     /// Returns true if \c n is hidden.
-    
-    ///\e
-    ///
     bool hidden(const Node& n) const { return !(*node_filter_map)[n]; }
 
-    /// Returns true if \c n is hidden.
-    
-    ///\e
-    ///
+    /// \brief Returns true if \c e is hidden.
+    ///
+    /// Returns true if \c e is hidden.
     bool hidden(const UEdge& e) const { return !(*uedge_filter_map)[e]; }
 
@@ -734 +733 @@
   /// node-filter.
   ///
-  /// Note that \c n is of type \c SubGA::NodeIt, but it can be converted to
-  /// \c Graph::Node that is why \c g.id(n) can be applied.
-  /// 
   template<typename _UGraph, typename NodeFilterMap, 
            typename UEdgeFilterMap, bool checked = true>