Changeset 2517:d9cfac072869 in lemon-0.x for lemon/bellman_ford.h

Timestamp:

11/20/07 22:40:55 (17 years ago)

Author:

Peter Kovacs

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3393

Message:

Small changes in the documentation.

File:

• lemon/bellman_ford.h (modified) (4 diffs)

lemon/bellman_ford.h

@@ -436 +436 @@
     /// 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() {
@@ -473 +473 @@
     /// 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) {
@@ -518 +518 @@
     ///
     /// \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)
@@ -526 +525 @@
     /// - 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);