diff -r a84e52e99f57 -r 74c2c81055e1 lemon/min_cost_flow.h --- a/lemon/min_cost_flow.h Sun Jan 13 10:26:55 2008 +0000 +++ b/lemon/min_cost_flow.h Sun Jan 13 10:32:14 2008 +0000 @@ -33,19 +33,22 @@ /// \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. /// \param LowerMap The type of the lower bound map. @@ -54,12 +57,12 @@ /// \param SupplyMap The type of the supply map. /// /// \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 @@ -70,53 +73,49 @@ typename SupplyMap = typename Graph::template NodeMap > 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; 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