lemon/bellman_ford.h
changeset 2408 467ca6d16556
parent 2394 8b9b44a9c754
child 2476 059dcdda37c5
     1.1 --- a/lemon/bellman_ford.h	Tue Mar 13 15:35:56 2007 +0000
     1.2 +++ b/lemon/bellman_ford.h	Tue Mar 13 15:42:06 2007 +0000
     1.3 @@ -38,7 +38,7 @@
     1.4    /// \brief Default OperationTraits for the BellmanFord algorithm class.
     1.5    ///  
     1.6    /// It defines all computational operations and constants which are
     1.7 -  /// used in the bellman ford algorithm. The default implementation
     1.8 +  /// used in the Bellman-Ford algorithm. The default implementation
     1.9    /// is based on the numeric_limits class. If the numeric type does not
    1.10    /// have infinity value then the maximum value is used as extremal
    1.11    /// infinity value.
    1.12 @@ -100,7 +100,7 @@
    1.13      // The type of the length of the edges.
    1.14      typedef typename _LengthMap::Value Value;
    1.15  
    1.16 -    /// \brief Operation traits for bellman-ford algorithm.
    1.17 +    /// \brief Operation traits for Bellman-Ford algorithm.
    1.18      ///
    1.19      /// It defines the infinity type on the given Value type
    1.20      /// and the used operation.
    1.21 @@ -410,8 +410,9 @@
    1.22      
    1.23      /// \brief Adds a new source node.
    1.24      ///
    1.25 -    /// The optional second parameter is the initial distance of the node.
    1.26 -    /// It just sets the distance of the node to the given value.
    1.27 +    /// Adds a new source node. The optional second parameter is the 
    1.28 +    /// initial distance of the node. It just sets the distance of the 
    1.29 +    /// node to the given value.
    1.30      void addSource(Node source, Value dst = OperationTraits::zero()) {
    1.31        _dist->set(source, dst);
    1.32        if (!(*_mask)[source]) {
    1.33 @@ -420,7 +421,7 @@
    1.34        }
    1.35      }
    1.36  
    1.37 -    /// \brief Executes one round from the bellman ford algorithm.
    1.38 +    /// \brief Executes one round from the Bellman-Ford algorithm.
    1.39      ///
    1.40      /// If the algoritm calculated the distances in the previous round
    1.41      /// exactly for all at most \f$ k \f$ length path lengths then it will
    1.42 @@ -463,7 +464,7 @@
    1.43        return _process.empty();
    1.44      }
    1.45  
    1.46 -    /// \brief Executes one weak round from the bellman ford algorithm.
    1.47 +    /// \brief Executes one weak round from the Bellman-Ford algorithm.
    1.48      ///
    1.49      /// If the algorithm calculated the distances in the
    1.50      /// previous round at least for all at most k length paths then it will
    1.51 @@ -517,7 +518,7 @@
    1.52      ///
    1.53      /// \pre init() must be called and at least one node should be added
    1.54      /// with addSource() before using this function. If there is
    1.55 -    /// a negative cycles in the graph it gives back false.
    1.56 +    /// a negative cycle in the graph it gives back false.
    1.57      ///
    1.58      /// This method runs the %BellmanFord algorithm from the root node(s)
    1.59      /// in order to compute the shortest path to each node. The algorithm 
    1.60 @@ -607,7 +608,7 @@
    1.61      
    1.62      ///@{
    1.63  
    1.64 -    /// \brief Lemon iterator for get a active nodes.
    1.65 +    /// \brief Lemon iterator for get the active nodes.
    1.66      ///
    1.67      /// Lemon iterator for get the active nodes. This class provides a
    1.68      /// common style lemon iterator which gives back a subset of the
    1.69 @@ -784,7 +785,7 @@
    1.70      /// \brief The value type of the length map.
    1.71      typedef typename _LengthMap::Value Value;
    1.72  
    1.73 -    /// \brief Operation traits for bellman-ford algorithm.
    1.74 +    /// \brief Operation traits for Bellman-Ford algorithm.
    1.75      ///
    1.76      /// It defines the infinity type on the given Value type
    1.77      /// and the used operation.