# Changeset 2517:d9cfac072869 in lemon-0.x

Ignore:
Timestamp:
11/20/07 22:40:55 (12 years ago)
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3393
Message:

Small changes in the documentation.

Location:
lemon
Files:
2 edited

Unmodified
Added
Removed
• ## lemon/bellman_ford.h

 r2476 /// the path. /// /// \return %True when the algorithm have not found more shorter /// \return \c true when the algorithm have not found more shorter /// paths. bool processNextRound() { /// at most k length minimal paths, this is why it is /// called just weak round. /// \return %True when the algorithm have not found more shorter paths. /// \return \c true when the algorithm have not found more shorter paths. bool processNextWeakRound() { for (int i = 0; i < int(_process.size()); ++i) { /// /// \pre init() must be called and at least one node should be added /// with addSource() before using this function. If there is /// a negative cycle in the graph it gives back false. /// with addSource() before using this function. /// /// This method runs the %BellmanFord algorithm from the root node(s) /// - The shortest path tree. /// - The distance of each node from the root(s). /// /// \return \c false if there is a negative cycle in the graph. bool checkedStart() { int num = countNodes(*graph);
• ## lemon/min_mean_cycle.h

 r2509 /// \return \c true if a cycle exists in the graph. /// /// \note Apart from the return value, m.run() is just a shortcut /// of the following code. /// \note Apart from the return value, m.run() is just a /// shortcut of the following code. /// \code ///   m.init(); /// \brief Initializes the internal data structures. /// /// Initializes the internal data structures. /// /// \sa reset() void init() { comp_num = stronglyConnectedComponents(graph, comp); /// and \ref findCycle() can be called again (e.g. when the /// underlaying graph has been modified). /// /// \sa init() void reset() { for (NodeIt u(graph); u != INVALID; ++u) /// Returns the total length of the found cycle. /// /// \pre \ref run() must be called before using this function. /// \pre \ref run() or \ref findCycle() must be called before /// using this function. If only \ref findMinMean() is called, /// the return value is not valid. Length cycleLength() const { return cycle_length; /// Returns the number of edges in the found cycle. /// /// \pre \ref run() must be called before using this function. /// \pre \ref run() or \ref findCycle() must be called before /// using this function. If only \ref findMinMean() is called, /// the return value is not valid. int cycleEdgeNum() const { return cycle_size; /// Returns the mean length of the found cycle. /// /// \pre \ref run() must be called before using this function. /// \pre \ref run() or \ref findMinMean() must be called before /// using this function. /// /// \warning LengthMap::Value must be convertible to double. /// /// \note m.minMean() is just a shortcut of the following code. /// \note m.minMean() is just a shortcut of the following /// code. /// \code ///   return m.cycleEdgeNum() / double(m.cycleLength()); ///   return m.cycleLength() / double(m.cycleEdgeNum()); /// \endcode /// However if only \ref findMinMean() is called before using this /// function, m.cycleLength() and m.cycleEdgeNum() /// are not valid alone, only their ratio is valid. double minMean() const { return cycle_length / (double)cycle_size;
Note: See TracChangeset for help on using the changeset viewer.