diff -r e866e288cba6 -r ae092c63d3ba lemon/min_cost_flow.h --- a/lemon/min_cost_flow.h Mon Feb 18 03:32:06 2008 +0000 +++ b/lemon/min_cost_flow.h Mon Feb 18 03:32:56 2008 +0000 @@ -36,33 +36,35 @@ /// \ref MinCostFlow provides an efficient algorithm for finding /// a minimum cost flow. /// - /// \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 exactly the same way. - /// - \ref CapacityScaling - /// - \ref CycleCanceling - /// - \ref NetworkSimplex - /// - /// \note For the detailed documentation of this class see + /// This class is just an alias for \ref NetworkSimplex, + /// which is the most efficient algorithm for the minimum cost + /// flow problem in LEMON according to our benchmark tests. + /// For the detailed documentation of this class see /// \ref NetworkSimplex. /// - /// \param Graph The directed graph type the algorithm runs on. - /// \param LowerMap The type of the lower bound map. - /// \param CapacityMap The type of the capacity (upper bound) map. - /// \param CostMap The type of the cost (length) map. - /// \param SupplyMap The type of the supply map. + /// There are four implementations for the minimum cost flow problem, + /// which can be used exactly the same way except for the fact that + /// \ref CycleCanceling does not provide dual solution (node + /// potentials) since it is a pure primal method. + /// - \ref CapacityScaling The capacity scaling algorithm. + /// - \ref CostScaling The cost scaling algorithm. + /// - \ref CycleCanceling A cycle-canceling algorithm. + /// - \ref NetworkSimplex The network simplex algorithm. + /// + /// \tparam Graph The directed graph type the algorithm runs on. + /// \tparam LowerMap The type of the lower bound map. + /// \tparam CapacityMap The type of the capacity (upper bound) map. + /// \tparam CostMap The type of the cost (length) map. + /// \tparam SupplyMap The type of the supply map. /// /// \warning - /// - 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. + /// - Edge capacities and costs should be \e non-negative \e integers. + /// - Supply values should be \e signed \e integers. + /// - \c LowerMap::Value must be convertible to \c CapacityMap::Value. + /// - \c CapacityMap::Value and \c SupplyMap::Value must be + /// convertible to each other. + /// - All value types must be convertible to \c CostMap::Value, which + /// must be signed type. /// /// \author Peter Kovacs