Changeset 2059:ebf3b2962554 in lemon-0.x for lemon/edmonds_karp.h

Timestamp:

04/18/06 09:02:32 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Doc fix

File:

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

lemon/edmonds_karp.h

@@ -42 +42 @@
   /// constructor.
   ///
-  /// The time complexity of the algorithm is O(n * e^2) in worst case. 
-  /// Always try the preflow algorithm instead of this if you does not
-  /// have some additional reason than to compute the optimal flow which
-  /// has O(n^3) time complexity.
+  /// The time complexity of the algorithm is \f$ O(n * e^2) \f$ in
+  /// worst case.  Always try the preflow algorithm instead of this if
+  /// you does not have some additional reason than to compute the
+  /// optimal flow which has \f$ O(n^3) \f$ time complexity.
   ///
   /// \param _Graph The directed graph type the algorithm runs on.
@@ -54 +54 @@
   ///
   /// \author Balazs Dezso 
+#ifdef DOXYGEN
+  template <typename _Graph, typename _Number,
+            typename _CapacityMap, typename _FlowMap, typename _Tolerance>
+#else
   template <typename _Graph, typename _Number,
             typename _CapacityMap = typename _Graph::template EdgeMap<_Number>,
             typename _FlowMap = typename _Graph::template EdgeMap<_Number>,
             typename _Tolerance = Tolerance<_Number> >
+#endif
   class EdmondsKarp {
   public:
@@ -108 +113 @@
     /// \param flow The flow of the edges. 
     /// \param tolerance Tolerance class.
-    /// Except the graph, all of these parameters can be reset by
-    /// calling \ref source, \ref target, \ref capacityMap and \ref
-    /// flowMap, resp.
     EdmondsKarp(const Graph& graph, Node source, Node target,
                 const CapacityMap& capacity, FlowMap& flow, 
@@ -240 +242 @@
     /// 
     /// It is just a shorthand for:
-    /// \code 
+    ///
+    ///\code 
     /// ek.init();
     /// ek.start();
-    /// \endcode
+    ///\endcode
     void run() {
       init();