Changeset 613:b5b5c4ae5107 in lemon-0.x for src/work/marci/max_bipartite_matching.h

Timestamp:

05/11/04 19:37:34 (21 years ago)

Author:

marci

Branch:

default

Phase:

public

Convert:

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

Message:

documentation of bipartite matchings, cleaning

File:

• src/work/marci/max_bipartite_matching.h (modified) (5 diffs)

src/work/marci/max_bipartite_matching.h

@@ -34 +34 @@
   // };
 
-  /// A bipartite matching class.
+  /// \brief A bipartite matching class.
+  ///
   /// This class reduces the matching problem to a flow problem and 
   /// a preflow is used on a wrapper. Such a generic approach means that 
@@ -40 +41 @@
   /// a similar way. Due to the efficiency of the preflow algorithm, an 
   /// efficient matching framework is obtained.
+  /// \ingroup galgs
   template <typename Graph, typename EdgeCap, typename NodeCap, 
             typename EdgeFlow, typename NodeFlow>
-  class MaxMatching {
+  class MaxBipartiteMatching {
   protected:
     //   EdgeCap* edge_cap;
@@ -66 +68 @@
     ///\bug Note that the values in _edge_flow and _node_flow have 
     /// to form a flow.
-    MaxMatching(Graph& _g, EdgeCap& _edge_cap, NodeCap& _node_cap, 
+    MaxBipartiteMatching(Graph& _g, EdgeCap& _edge_cap, NodeCap& _node_cap, 
                 EdgeFlow& _edge_flow, NodeFlow& _node_flow) : 
       stgw(_g), 
@@ -77 +79 @@
     ///\bug Note that the values in _edge_flow and _node_flow have 
     /// to form a flow.
-    MaxMatching(Graph& _g, EdgeCap& _edge_cap, NodeCap& _node_cap, 
+    MaxBipartiteMatching(Graph& _g, EdgeCap& _edge_cap, NodeCap& _node_cap, 
                 EdgeFlow& _edge_flow/*, NodeFlow& _node_flow*/) : 
       stgw(_g), 
@@ -85 +87 @@
       mf(stgw, stgw.S_NODE, stgw.T_NODE, cap, flow) { }
     /// The class have a nontrivial destructor.
-    ~MaxMatching() { if (node_flow) delete node_flow; }
+    ~MaxBipartiteMatching() { if (node_flow) delete node_flow; }
     /// run computes the max matching.
     void run() { mf.run(); }