Changeset 2556:74c2c81055e1 in lemon-0.x for lemon/min_cost_flow.h

Timestamp:

01/13/08 11:32:14 (16 years ago)

Author:

Peter Kovacs

Branch:

default

Phase:

public

Convert:

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

Message:

Cleanup in the minimum cost flow files.
The changes only affects the documentation and the look of the source codes.

File:

• lemon/min_cost_flow.h (modified) (4 diffs)

lemon/min_cost_flow.h

@@ -34 +34 @@
   /// \brief An efficient algorithm for finding a minimum cost flow.
   ///
-  /// \ref lemon::MinCostFlow "MinCostFlow" implements an efficient
-  /// algorithm for finding a minimum cost flow.
+  /// \ref MinCostFlow provides an efficient algorithm for finding
+  /// a minimum cost flow.
   ///
-  /// \note \ref lemon::MinCostFlow "MinCostFlow" is just an alias for
-  /// \ref lemon::NetworkSimplex "NetworkSimplex", wich is the most
-  /// efficient implementation for the minimum cost flow problem in the
-  /// LEMON library according to our benchmark tests.
+  /// \note \ref MinCostFlow is just an alias for \ref NetworkSimplex,
+  /// which is the most efficient implementation for the minimum cost
+  /// flow problem in the LEMON library according to our benchmark
+  /// tests.
   ///
   /// \note There are three implementations for the minimum cost flow
-  /// problem, that can be used in the same way.
-  /// - \ref lemon::CapacityScaling "CapacityScaling"
-  /// - \ref lemon::CycleCanceling "CycleCanceling"
-  /// - \ref lemon::NetworkSimplex "NetworkSimplex"
+  /// problem, that can be used exactly the same way.
+  /// - \ref CapacityScaling
+  /// - \ref CycleCanceling
+  /// - \ref NetworkSimplex
+  ///
+  /// \note For the detailed documentation of this class see
+  /// \ref NetworkSimplex.
   ///
   /// \param Graph The directed graph type the algorithm runs on.
@@ -55 +58 @@
   ///
   /// \warning
-  /// - Edge capacities and costs should be nonnegative integers.
-  ///   However \c CostMap::Value should be signed type.
+  /// - Edge capacities and costs should be non-negative integers.
+  ///   However \c CostMap::Value should be signed type.
   /// - Supply values should be signed integers.
   /// - \c LowerMap::Value must be convertible to
-  ///   \c CapacityMap::Value and \c CapacityMap::Value must be
-  ///   convertible to \c SupplyMap::Value.
+  ///   \c CapacityMap::Value and \c CapacityMap::Value must be
+  ///   convertible to \c SupplyMap::Value.
   ///
   /// \author Peter Kovacs
@@ -71 +74 @@
                                   <typename CapacityMap::Value> >
   class MinCostFlow :
-    public NetworkSimplex< Graph,
-                           LowerMap,
-                           CapacityMap,
-                           CostMap,
-                           SupplyMap >
+    public NetworkSimplex< Graph, LowerMap, CapacityMap,
+                           CostMap, SupplyMap >
   {
     typedef NetworkSimplex< Graph, LowerMap, CapacityMap,
-                            CostMap, SupplyMap >
-      MinCostFlowImpl;
+                            CostMap, SupplyMap > MinCostFlowImpl;
     typedef typename Graph::Node Node;
     typedef typename SupplyMap::Value Supply;
@@ -85 +84 @@
   public:
 
-    /// \brief General constructor of the class (with lower bounds).
-    MinCostFlow( const Graph &_graph,
-                 const LowerMap &_lower,
-                 const CapacityMap &_capacity,
-                 const CostMap &_cost,
-                 const SupplyMap &_supply ) :
-      MinCostFlowImpl(_graph, _lower, _capacity, _cost, _supply) {}
+    /// General constructor of the class (with lower bounds).
+    MinCostFlow( const Graph &graph,
+                 const LowerMap &lower,
+                 const CapacityMap &capacity,
+                 const CostMap &cost,
+                 const SupplyMap &supply ) :
+      MinCostFlowImpl(graph, lower, capacity, cost, supply) {}
 
-    /// \brief General constructor of the class (without lower bounds).
-    MinCostFlow( const Graph &_graph,
-                 const CapacityMap &_capacity,
-                 const CostMap &_cost,
-                 const SupplyMap &_supply ) :
-      MinCostFlowImpl(_graph, _capacity, _cost, _supply) {}
+    /// General constructor of the class (without lower bounds).
+    MinCostFlow( const Graph &graph,
+                 const CapacityMap &capacity,
+                 const CostMap &_ost,
+                 const SupplyMap &supply ) :
+      MinCostFlowImpl(graph, capacity, cost, supply) {}
 
-    /// \brief Simple constructor of the class (with lower bounds).
-    MinCostFlow( const Graph &_graph,
-                 const LowerMap &_lower,
-                 const CapacityMap &_capacity,
-                 const CostMap &_cost,
-                 Node _s, Node _t,
-                 Supply _flow_value ) :
-      MinCostFlowImpl( _graph, _lower, _capacity, _cost,
-                       _s, _t, _flow_value ) {}
+    /// Simple constructor of the class (with lower bounds).
+    MinCostFlow( const Graph &graph,
+                 const LowerMap &lower,
+                 const CapacityMap &capacity,
+                 const CostMap &_ost,
+                 Node s, Node t,
+                 Supply flow_value ) :
+      MinCostFlowImpl( graph, lower, capacity, cost,
+                       s, t, flow_value ) {}
 
-    /// \brief Simple constructor of the class (without lower bounds).
-    MinCostFlow( const Graph &_graph,
-                 const CapacityMap &_capacity,
-                 const CostMap &_cost,
-                 Node _s, Node _t,
-                 Supply _flow_value ) :
-      MinCostFlowImpl( _graph, _capacity, _cost,
-                       _s, _t, _flow_value ) {}
+    /// Simple constructor of the class (without lower bounds).
+    MinCostFlow( const Graph &graph,
+                 const CapacityMap &capacity,
+                 const CostMap &cost,
+                 Node s, Node t,
+                 Supply flow_value ) :
+      MinCostFlowImpl( graph, capacity, cost,
+                       s, t, flow_value ) {}
 
   }; //class MinCostFlow