lemon/bellman_ford.h
changeset 2517 d9cfac072869
parent 2476 059dcdda37c5
child 2553 bfced05fa852
     1.1 --- a/lemon/bellman_ford.h	Tue Nov 20 15:06:03 2007 +0000
     1.2 +++ b/lemon/bellman_ford.h	Tue Nov 20 21:40:55 2007 +0000
     1.3 @@ -435,7 +435,7 @@
     1.4      /// after each iteration the \ref predMap() map and manually build
     1.5      /// the path.
     1.6      ///
     1.7 -    /// \return %True when the algorithm have not found more shorter
     1.8 +    /// \return \c true when the algorithm have not found more shorter
     1.9      /// paths.
    1.10      bool processNextRound() {
    1.11        for (int i = 0; i < int(_process.size()); ++i) {
    1.12 @@ -472,7 +472,7 @@
    1.13      /// This function does not make it possible to calculate strictly the
    1.14      /// at most k length minimal paths, this is why it is
    1.15      /// called just weak round.
    1.16 -    /// \return %True when the algorithm have not found more shorter paths.
    1.17 +    /// \return \c true when the algorithm have not found more shorter paths.
    1.18      bool processNextWeakRound() {
    1.19        for (int i = 0; i < int(_process.size()); ++i) {
    1.20  	_mask->set(_process[i], false);
    1.21 @@ -517,14 +517,15 @@
    1.22      /// \brief Executes the algorithm and checks the negative cycles.
    1.23      ///
    1.24      /// \pre init() must be called and at least one node should be added
    1.25 -    /// with addSource() before using this function. If there is
    1.26 -    /// a negative cycle in the graph it gives back false.
    1.27 +    /// with addSource() before using this function. 
    1.28      ///
    1.29      /// This method runs the %BellmanFord algorithm from the root node(s)
    1.30      /// in order to compute the shortest path to each node. The algorithm 
    1.31      /// computes 
    1.32      /// - The shortest path tree.
    1.33      /// - The distance of each node from the root(s).
    1.34 +    /// 
    1.35 +    /// \return \c false if there is a negative cycle in the graph.
    1.36      bool checkedStart() {
    1.37        int num = countNodes(*graph);
    1.38        for (int i = 0; i < num; ++i) {