Changeset 2408:467ca6d16556 in lemon-0.x for lemon/bellman_ford.h

Timestamp:

03/13/07 16:42:06 (17 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Doc improvements contributed by Peter Kovacs.

File:

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

lemon/bellman_ford.h

@@ -39 +39 @@
   ///  
   /// It defines all computational operations and constants which are
-  /// used in the bellman ford algorithm. The default implementation
+  /// used in the Bellman-Ford algorithm. The default implementation
   /// is based on the numeric_limits class. If the numeric type does not
   /// have infinity value then the maximum value is used as extremal
@@ -101 +101 @@
     typedef typename _LengthMap::Value Value;
 
-    /// \brief Operation traits for bellman-ford algorithm.
+    /// \brief Operation traits for Bellman-Ford algorithm.
     ///
     /// It defines the infinity type on the given Value type
@@ -411 +411 @@
     /// \brief Adds a new source node.
     ///
-    /// The optional second parameter is the initial distance of the node.
-    /// It just sets the distance of the node to the given value.
+    /// Adds a new source node. The optional second parameter is the 
+    /// initial distance of the node. It just sets the distance of the 
+    /// node to the given value.
     void addSource(Node source, Value dst = OperationTraits::zero()) {
       _dist->set(source, dst);
@@ -421 +422 @@
     }
 
-    /// \brief Executes one round from the bellman ford algorithm.
+    /// \brief Executes one round from the Bellman-Ford algorithm.
     ///
     /// If the algoritm calculated the distances in the previous round
@@ -464 +465 @@
     }
 
-    /// \brief Executes one weak round from the bellman ford algorithm.
+    /// \brief Executes one weak round from the Bellman-Ford algorithm.
     ///
     /// If the algorithm calculated the distances in the
@@ -518 +519 @@
     /// \pre init() must be called and at least one node should be added
     /// with addSource() before using this function. If there is
-    /// a negative cycles in the graph it gives back false.
+    /// a negative cycle in the graph it gives back false.
     ///
     /// This method runs the %BellmanFord algorithm from the root node(s)
@@ -608 +609 @@
     ///@{
 
-    /// \brief Lemon iterator for get a active nodes.
+    /// \brief Lemon iterator for get the active nodes.
     ///
     /// Lemon iterator for get the active nodes. This class provides a
@@ -785 +786 @@
     typedef typename _LengthMap::Value Value;
 
-    /// \brief Operation traits for bellman-ford algorithm.
+    /// \brief Operation traits for Bellman-Ford algorithm.
     ///
     /// It defines the infinity type on the given Value type