COIN-OR::LEMON - Graph Library

Changeset 2620:8f41a3129746 in lemon-0.x for lemon/min_cost_max_flow.h


Ignore:
Timestamp:
10/05/08 15:37:17 (11 years ago)
Author:
Peter Kovacs
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3505
Message:

Doc improvements

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/min_cost_max_flow.h

    r2587 r2620  
    5959  ///
    6060  /// \author Peter Kovacs
    61 
    6261  template < typename Graph,
    6362             typename CapacityMap = typename Graph::template EdgeMap<int>,
     
    128127    }
    129128
    130     /// \brief Sets the flow map.
    131     ///
    132     /// Sets the flow map.
     129    /// \brief Set the flow map.
     130    ///
     131    /// Set the flow map.
    133132    ///
    134133    /// \return \c (*this)
     
    142141    }
    143142
    144     /// \brief Sets the potential map.
    145     ///
    146     /// Sets the potential map.
     143    /// \brief Set the potential map.
     144    ///
     145    /// Set the potential map.
    147146    ///
    148147    /// \return \c (*this)
     
    157156
    158157    /// \name Execution control
    159     /// The only way to execute the algorithm is to call the run()
    160     /// function.
    161158
    162159    /// @{
    163160
    164     /// \brief Runs the algorithm.
    165     ///
    166     /// Runs the algorithm.
     161    /// \brief Run the algorithm.
     162    ///
     163    /// Run the algorithm.
    167164    void run() {
    168165      // Initializing maps
     
    187184
    188185    /// \name Query Functions
    189     /// The result of the algorithm can be obtained using these
    190     /// functions.
    191     /// \n run() must be called before using them.
     186    /// The results of the algorithm can be obtained using these
     187    /// functions.\n
     188    /// \ref lemon::MinCostMaxFlow::run() "run()" must be called before
     189    /// using them.
    192190
    193191    /// @{
    194192
    195     /// \brief Returns a const reference to the edge map storing the
     193    /// \brief Return a const reference to the edge map storing the
    196194    /// found flow.
    197195    ///
    198     /// Returns a const reference to the edge map storing the found flow.
     196    /// Return a const reference to the edge map storing the found flow.
    199197    ///
    200198    /// \pre \ref run() must be called before using this function.
     
    203201    }
    204202
    205     /// \brief Returns a const reference to the node map storing the
     203    /// \brief Return a const reference to the node map storing the
    206204    /// found potentials (the dual solution).
    207205    ///
    208     /// Returns a const reference to the node map storing the found
     206    /// Return a const reference to the node map storing the found
    209207    /// potentials (the dual solution).
    210208    ///
     
    214212    }
    215213
    216     /// \brief Returns the flow on the given edge.
    217     ///
    218     /// Returns the flow on the given edge.
     214    /// \brief Return the flow on the given edge.
     215    ///
     216    /// Return the flow on the given edge.
    219217    ///
    220218    /// \pre \ref run() must be called before using this function.
     
    223221    }
    224222
    225     /// \brief Returns the potential of the given node.
    226     ///
    227     /// Returns the potential of the given node.
     223    /// \brief Return the potential of the given node.
     224    ///
     225    /// Return the potential of the given node.
    228226    ///
    229227    /// \pre \ref run() must be called before using this function.
     
    232230    }
    233231
    234     /// \brief Returns the total cost of the found flow.
    235     ///
    236     /// Returns the total cost of the found flow. The complexity of the
     232    /// \brief Return the total cost of the found flow.
     233    ///
     234    /// Return the total cost of the found flow. The complexity of the
    237235    /// function is \f$ O(e) \f$.
    238236    ///
Note: See TracChangeset for help on using the changeset viewer.