src/lemon/dijkstra.h
changeset 1151 b217fc69f913
parent 1132 ab5c81fcc31a
child 1155 fe0fcdb5687b
     1.1 --- a/src/lemon/dijkstra.h	Tue Feb 15 15:00:31 2005 +0000
     1.2 +++ b/src/lemon/dijkstra.h	Wed Feb 16 16:17:30 2005 +0000
     1.3 @@ -30,9 +30,7 @@
     1.4  namespace lemon {
     1.5  
     1.6  
     1.7 -/// \addtogroup flowalgs
     1.8 -/// @{
     1.9 -
    1.10 +  
    1.11    ///Default traits class of Dijkstra class.
    1.12  
    1.13    ///Default traits class of Dijkstra class.
    1.14 @@ -129,6 +127,7 @@
    1.15    
    1.16    ///%Dijkstra algorithm class.
    1.17    
    1.18 +  /// \ingroup flowalgs
    1.19    ///This class provides an efficient implementation of %Dijkstra algorithm.
    1.20    ///The edge lengths are passed to the algorithm using a
    1.21    ///\ref concept::ReadMap "ReadMap",
    1.22 @@ -496,7 +495,7 @@
    1.23        if(_heap.state(s) != Heap::IN_HEAP) _heap.push(s,dst);
    1.24      }
    1.25      
    1.26 -    void processNode()
    1.27 +    void processNextNode()
    1.28      {
    1.29        Node v=_heap.top(); 
    1.30        Value oldvalue=_heap[v];
    1.31 @@ -540,7 +539,7 @@
    1.32      ///
    1.33      void start()
    1.34      {
    1.35 -      while ( !_heap.empty() ) processNode();
    1.36 +      while ( !_heap.empty() ) processNextNode();
    1.37      }
    1.38      
    1.39      ///Executes the algorithm until \c dest is reached.
    1.40 @@ -559,7 +558,7 @@
    1.41      ///
    1.42      void start(Node dest)
    1.43      {
    1.44 -      while ( !_heap.empty() && _heap.top()!=dest ) processNode();
    1.45 +      while ( !_heap.empty() && _heap.top()!=dest ) processNextNode();
    1.46        if ( _heap.top()==dest ) finalizeNodeData(_heap.top());
    1.47      }
    1.48      
    1.49 @@ -575,7 +574,7 @@
    1.50      template<class NM>
    1.51      void start(const NM &nm)
    1.52      {
    1.53 -      while ( !_heap.empty() && !mn[_heap.top()] ) processNode();
    1.54 +      while ( !_heap.empty() && !mn[_heap.top()] ) processNextNode();
    1.55        if ( !_heap.empty() ) finalizeNodeData(_heap.top());
    1.56      }
    1.57      
    1.58 @@ -695,8 +694,10 @@
    1.59  
    1.60    /// Default traits used by \ref DijkstraWizard
    1.61  
    1.62 -  /// To make it easier to use Dijkstra algorithm we have created a wizard class.
    1.63 -  /// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
    1.64 +  /// To make it easier to use Dijkstra algorithm
    1.65 +  ///we have created a wizard class.
    1.66 +  /// This \ref DijkstraWizard class needs default traits,
    1.67 +  ///as well as the \ref Dijkstra class.
    1.68    /// The \ref DijkstraWizardBase is a class to be the default traits of the
    1.69    /// \ref DijkstraWizard class.
    1.70    template<class GR,class LM>
    1.71 @@ -744,15 +745,19 @@
    1.72    
    1.73    /// A class to make easier the usage of Dijkstra algorithm
    1.74  
    1.75 +  /// \ingroup flowalgs
    1.76    /// This class is created to make it easier to use Dijkstra algorithm.
    1.77    /// It uses the functions and features of the plain \ref Dijkstra,
    1.78 -  /// but it is much more simple to use it.
    1.79 +  /// but it is much simpler to use it.
    1.80    ///
    1.81    /// Simplicity means that the way to change the types defined
    1.82    /// in the traits class is based on functions that returns the new class
    1.83 -  /// and not on templatable built-in classes. When using the plain \ref Dijkstra
    1.84 -  /// the new class with the modified type comes from the original class by using the ::
    1.85 -  /// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
    1.86 +  /// and not on templatable built-in classes.
    1.87 +  /// When using the plain \ref Dijkstra
    1.88 +  /// the new class with the modified type comes from
    1.89 +  /// the original class by using the ::
    1.90 +  /// operator. In the case of \ref DijkstraWizard only
    1.91 +  /// a function have to be called and it will
    1.92    /// return the needed class.
    1.93    ///
    1.94    /// It does not have own \ref run method. When its \ref run method is called
    1.95 @@ -898,6 +903,7 @@
    1.96    
    1.97    ///\e
    1.98  
    1.99 +  /// \ingroup flowalgs
   1.100    ///\todo Please document...
   1.101    ///
   1.102    template<class GR, class LM>