diff -r 94387da47f79 -r c5fd2d996909 lemon/suurballe.h --- a/lemon/suurballe.h Thu Mar 05 10:13:20 2009 +0000 +++ b/lemon/suurballe.h Sun Mar 29 23:08:20 2009 +0200 @@ -45,9 +45,9 @@ /// In fact, this implementation is the specialization of the /// \ref CapacityScaling "successive shortest path" algorithm. /// - /// \tparam Digraph The digraph type the algorithm runs on. + /// \tparam GR The digraph type the algorithm runs on. /// The default value is \c ListDigraph. - /// \tparam LengthMap The type of the length (cost) map. + /// \tparam LEN The type of the length (cost) map. /// The default value is Digraph::ArcMap. /// /// \warning Length values should be \e non-negative \e integers. @@ -55,21 +55,26 @@ /// \note For finding node-disjoint paths this algorithm can be used /// with \ref SplitNodes. #ifdef DOXYGEN - template + template #else - template < typename Digraph = ListDigraph, - typename LengthMap = typename Digraph::template ArcMap > + template < typename GR = ListDigraph, + typename LEN = typename GR::template ArcMap > #endif class Suurballe { - TEMPLATE_DIGRAPH_TYPEDEFS(Digraph); + TEMPLATE_DIGRAPH_TYPEDEFS(GR); - typedef typename LengthMap::Value Length; typedef ConstMap ConstArcMap; - typedef typename Digraph::template NodeMap PredMap; + typedef typename GR::template NodeMap PredMap; public: + /// The type of the digraph the algorithm runs on. + typedef GR Digraph; + /// The type of the length map. + typedef LEN LengthMap; + /// The type of the lengths. + typedef typename LengthMap::Value Length; /// The type of the flow map. typedef typename Digraph::template ArcMap FlowMap; /// The type of the potential map. @@ -256,7 +261,7 @@ /// The found flow contains only 0 and 1 values. It is the union of /// the found arc-disjoint paths. /// - /// \return \c (*this) + /// \return (*this) Suurballe& flowMap(FlowMap &map) { if (_local_flow) { delete _flow; @@ -273,7 +278,7 @@ /// The potentials provide the dual solution of the underlying /// minimum cost flow problem. /// - /// \return \c (*this) + /// \return (*this) Suurballe& potentialMap(PotentialMap &map) { if (_local_potential) { delete _potential; @@ -458,7 +463,7 @@ /// \brief Return the total length (cost) of the found paths (flow). /// /// This function returns the total length (cost) of the found paths - /// (flow). The complexity of the function is \f$ O(e) \f$. + /// (flow). The complexity of the function is O(e). /// /// \pre \ref run() or \ref findFlow() must be called before using /// this function.