Changeset 2084:59769591eb60 in lemon-0.x for lemon/graph_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/graph_adaptor.h (modified) (3 diffs)

lemon/graph_adaptor.h

@@ -265 +265 @@
   /// implements the graph obtained from \c g by 
   /// reversing the orientation of its edges.
+  ///
+  /// A good example of using RevGraphAdaptor is to decide that the
+  /// directed graph is wheter strongly connected or not. If from one
+  /// node each node is reachable and from each node is reachable this
+  /// node then and just then the graph is strongly connected. Instead of
+  /// this condition we use a little bit different. From one node each node
+  /// ahould be reachable in the graph and in the reversed graph. Now this
+  /// condition can be checked with the Dfs algorithm class and the
+  /// RevGraphAdaptor algorithm class.
+  ///
+  /// And look at the code:
+  ///
+  ///\code
+  /// bool stronglyConnected(const Graph& graph) {
+  ///   if (NodeIt(graph) == INVALID) return true;
+  ///   Dfs<Graph> dfs(graph);
+  ///   dfs.run(NodeIt(graph));
+  ///   for (NodeIt it(graph); it != INVALID; ++it) {
+  ///     if (!dfs.reached(it)) {
+  ///       return false;
+  ///     }
+  ///   }
+  ///   typedef RevGraphAdaptor<const Graph> RGraph;
+  ///   RGraph rgraph(graph);
+  ///   DfsVisit<RGraph> rdfs(rgraph);
+  ///   rdfs.run(NodeIt(graph));
+  ///   for (NodeIt it(graph); it != INVALID; ++it) {
+  ///     if (!rdfs.reached(it)) {
+  ///       return false;
+  ///     }
+  ///   }
+  ///   return true;
+  /// }
+  ///\endcode
   template<typename _Graph>
   class RevGraphAdaptor : 
@@ -2388 +2422 @@
   ///
   /// The second solution contains just 3 disjoint paths while the first 4.
-  /// The full code can be found in the \ref disjoint_paths.cc demo file.
+  /// The full code can be found in the \ref disjoint_paths_demo.cc demo file.
   ///
   /// This graph adaptor is fully conform to the 
@@ -2588 +2622 @@
   };
 
+  /// \brief Just gives back a split graph adaptor
+  ///
+  /// Just gives back a split graph adaptor
+  template<typename Graph>
+  SplitGraphAdaptor<Graph>
+  splitGraphAdaptor(const Graph& graph) {
+    return SplitGraphAdaptor<Graph>(graph);
+  }
+
 
 } //namespace lemon