1.1 --- a/lemon/cycle_canceling.h Sun Oct 05 13:36:43 2008 +0000
1.2 +++ b/lemon/cycle_canceling.h Sun Oct 05 13:37:17 2008 +0000
1.3 @@ -64,7 +64,6 @@
1.4 /// parameter.
1.5 ///
1.6 /// \author Peter Kovacs
1.7 -
1.8 template < typename Graph,
1.9 typename LowerMap = typename Graph::template EdgeMap<int>,
1.10 typename CapacityMap = typename Graph::template EdgeMap<int>,
1.11 @@ -98,8 +97,7 @@
1.12
1.13 /// \brief Map adaptor class for handling residual edge costs.
1.14 ///
1.15 - /// \ref ResidualCostMap is a map adaptor class for handling
1.16 - /// residual edge costs.
1.17 + /// Map adaptor class for handling residual edge costs.
1.18 class ResidualCostMap : public MapBase<ResEdge, Cost>
1.19 {
1.20 private:
1.21 @@ -278,9 +276,9 @@
1.22 delete _res_graph;
1.23 }
1.24
1.25 - /// \brief Sets the flow map.
1.26 + /// \brief Set the flow map.
1.27 ///
1.28 - /// Sets the flow map.
1.29 + /// Set the flow map.
1.30 ///
1.31 /// \return \c (*this)
1.32 CycleCanceling& flowMap(FlowMap &map) {
1.33 @@ -292,9 +290,9 @@
1.34 return *this;
1.35 }
1.36
1.37 - /// \brief Sets the potential map.
1.38 + /// \brief Set the potential map.
1.39 ///
1.40 - /// Sets the potential map.
1.41 + /// Set the potential map.
1.42 ///
1.43 /// \return \c (*this)
1.44 CycleCanceling& potentialMap(PotentialMap &map) {
1.45 @@ -307,14 +305,12 @@
1.46 }
1.47
1.48 /// \name Execution control
1.49 - /// The only way to execute the algorithm is to call the run()
1.50 - /// function.
1.51
1.52 /// @{
1.53
1.54 - /// \brief Runs the algorithm.
1.55 + /// \brief Run the algorithm.
1.56 ///
1.57 - /// Runs the algorithm.
1.58 + /// Run the algorithm.
1.59 ///
1.60 /// \param min_mean_cc Set this parameter to \c true to run the
1.61 /// "Minimum Mean Cycle-Canceling" algorithm, which is strongly
1.62 @@ -329,25 +325,26 @@
1.63
1.64 /// \name Query Functions
1.65 /// The result of the algorithm can be obtained using these
1.66 - /// functions.
1.67 - /// \n run() must be called before using them.
1.68 + /// functions.\n
1.69 + /// \ref lemon::CycleCanceling::run() "run()" must be called before
1.70 + /// using them.
1.71
1.72 /// @{
1.73
1.74 - /// \brief Returns a const reference to the edge map storing the
1.75 + /// \brief Return a const reference to the edge map storing the
1.76 /// found flow.
1.77 ///
1.78 - /// Returns a const reference to the edge map storing the found flow.
1.79 + /// Return a const reference to the edge map storing the found flow.
1.80 ///
1.81 /// \pre \ref run() must be called before using this function.
1.82 const FlowMap& flowMap() const {
1.83 return *_flow;
1.84 }
1.85
1.86 - /// \brief Returns a const reference to the node map storing the
1.87 + /// \brief Return a const reference to the node map storing the
1.88 /// found potentials (the dual solution).
1.89 ///
1.90 - /// Returns a const reference to the node map storing the found
1.91 + /// Return a const reference to the node map storing the found
1.92 /// potentials (the dual solution).
1.93 ///
1.94 /// \pre \ref run() must be called before using this function.
1.95 @@ -355,27 +352,27 @@
1.96 return *_potential;
1.97 }
1.98
1.99 - /// \brief Returns the flow on the given edge.
1.100 + /// \brief Return the flow on the given edge.
1.101 ///
1.102 - /// Returns the flow on the given edge.
1.103 + /// Return the flow on the given edge.
1.104 ///
1.105 /// \pre \ref run() must be called before using this function.
1.106 Capacity flow(const Edge& edge) const {
1.107 return (*_flow)[edge];
1.108 }
1.109
1.110 - /// \brief Returns the potential of the given node.
1.111 + /// \brief Return the potential of the given node.
1.112 ///
1.113 - /// Returns the potential of the given node.
1.114 + /// Return the potential of the given node.
1.115 ///
1.116 /// \pre \ref run() must be called before using this function.
1.117 Cost potential(const Node& node) const {
1.118 return (*_potential)[node];
1.119 }
1.120
1.121 - /// \brief Returns the total cost of the found flow.
1.122 + /// \brief Return the total cost of the found flow.
1.123 ///
1.124 - /// Returns the total cost of the found flow. The complexity of the
1.125 + /// Return the total cost of the found flow. The complexity of the
1.126 /// function is \f$ O(e) \f$.
1.127 ///
1.128 /// \pre \ref run() must be called before using this function.
1.129 @@ -390,7 +387,7 @@
1.130
1.131 private:
1.132
1.133 - /// Initializes the algorithm.
1.134 + /// Initialize the algorithm.
1.135 bool init() {
1.136 if (!_valid_supply) return false;
1.137
1.138 @@ -428,9 +425,9 @@
1.139 return true;
1.140 }
1.141
1.142 - /// \brief Executes the algorithm using \ref BellmanFord.
1.143 + /// \brief Execute the algorithm using \ref BellmanFord.
1.144 ///
1.145 - /// Executes the algorithm using the \ref BellmanFord
1.146 + /// Execute the algorithm using the \ref BellmanFord
1.147 /// "Bellman-Ford" algorithm for negative cycle detection with
1.148 /// successively larger limit for the number of iterations.
1.149 void start() {
1.150 @@ -506,9 +503,9 @@
1.151 }
1.152 }
1.153
1.154 - /// \brief Executes the algorithm using \ref MinMeanCycle.
1.155 + /// \brief Execute the algorithm using \ref MinMeanCycle.
1.156 ///
1.157 - /// Executes the algorithm using \ref MinMeanCycle for negative
1.158 + /// Execute the algorithm using \ref MinMeanCycle for negative
1.159 /// cycle detection.
1.160 void startMinMean() {
1.161 typedef Path<ResGraph> ResPath;