lemon-0.x: comparison src/lemon/dijkstra.h

equal deleted inserted replaced

-:336ccb68d28b
+:b09854556d55
 #include <lemon/maps.h>
 namespace lemon {
-/// \addtogroup flowalgs
-/// @{
 ///Default traits class of Dijkstra class.
 ///Default traits class of Dijkstra class.
 ///\param GR Graph type.
 ///\param LM Type of length map.
 }
 };
 ///%Dijkstra algorithm class.
+/// \ingroup flowalgs
 ///This class provides an efficient implementation of %Dijkstra algorithm.
 ///The edge lengths are passed to the algorithm using a
 ///\ref concept::ReadMap "ReadMap",
 ///so it is easy to change it to any kind of length.
 ///
 {
 source = s;
 if(_heap.state(s) != Heap::IN_HEAP) _heap.push(s,dst);
 }
-void processNode()
+void processNextNode()
 {
 Node v=_heap.top();
 Value oldvalue=_heap[v];
 _heap.pop();
 finalizeNodeData(v,oldvalue);
 ///- The shortest path tree.
 ///- The distance of each node from the root(s).
 ///
 void start()
 {
-while ( !_heap.empty() ) processNode();
+while ( !_heap.empty() ) processNextNode();
 }
 ///Executes the algorithm until \c dest is reached.
 ///Executes the algorithm until \c dest is reached.
 ///- The shortest path to \c  dest.
 ///- The distance of \c dest from the root(s).
 ///
 void start(Node dest)
 {
-while ( !_heap.empty() && _heap.top()!=dest ) processNode();
+while ( !_heap.empty() && _heap.top()!=dest ) processNextNode();
 if ( _heap.top()==dest ) finalizeNodeData(_heap.top());
 }
 ///Executes the algorithm until a condition is met.
 ///\param nm must be a bool (or convertible) node map. The algorithm
 ///will stop when it reaches a node \c v with <tt>nm[v]==true</tt>.
 template<class NM>
 void start(const NM &nm)
 {
-while ( !_heap.empty() && !mn[_heap.top()] ) processNode();
+while ( !_heap.empty() && !mn[_heap.top()] ) processNextNode();
 if ( !_heap.empty() ) finalizeNodeData(_heap.top());
 }
 ///Runs %Dijkstra algorithm from node \c s.
 ///@}
 };
 /// Default traits used by \ref DijkstraWizard
-/// To make it easier to use Dijkstra algorithm we have created a wizard class.
+/// To make it easier to use Dijkstra algorithm
-/// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
+///we have created a wizard class.
+/// This \ref DijkstraWizard class needs default traits,
+///as well as the \ref Dijkstra class.
 /// The \ref DijkstraWizardBase is a class to be the default traits of the
 /// \ref DijkstraWizard class.
 template<class GR,class LM>
 class DijkstraWizardBase : public DijkstraDefaultTraits<GR,LM>
 {
 };
 /// A class to make easier the usage of Dijkstra algorithm
+/// \ingroup flowalgs
 /// This class is created to make it easier to use Dijkstra algorithm.
 /// It uses the functions and features of the plain \ref Dijkstra,
-/// but it is much more simple to use it.
+/// but it is much simpler to use it.
 ///
 /// Simplicity means that the way to change the types defined
 /// in the traits class is based on functions that returns the new class
-/// and not on templatable built-in classes. When using the plain \ref Dijkstra
+/// and not on templatable built-in classes.
-/// the new class with the modified type comes from the original class by using the ::
+/// When using the plain \ref Dijkstra
-/// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
+/// the new class with the modified type comes from
+/// the original class by using the ::
+/// operator. In the case of \ref DijkstraWizard only
+/// a function have to be called and it will
 /// return the needed class.
 ///
 /// It does not have own \ref run method. When its \ref run method is called
 /// it initiates a plain \ref Dijkstra class, and calls the \ref Dijkstra::run
 /// method of it.
 };
 ///\e
+/// \ingroup flowalgs
 ///\todo Please document...
 ///
 template<class GR, class LM>
 DijkstraWizard<DijkstraWizardBase<GR,LM> >
 dijkstra(const GR &g,const LM &l,typename GR::Node s=INVALID)

changeset 1152	1765ff9fefa1
parent 1132	ab5c81fcc31a
child 1155	fe0fcdb5687b