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

equal deleted inserted replaced

-:07fe0c0e7d21
+:030c99eec3d5
 {
 ///The graph type the algorithm runs on.
 typedef GR Graph;
 ///The type of the map that stores the edge lengths.
+///The type of the map that stores the edge lengths.
 ///It must meet the \ref concept::ReadMap "ReadMap" concept.
-///
 typedef LM LengthMap;
 //The type of the length of the edges.
 typedef typename LM::Value Value;
 ///The heap type used by Dijkstra algorithm.
 		    std::less<Value> > Heap;
 ///\brief The type of the map that stores the last
 ///edges of the shortest paths.
 ///
+///The type of the map that stores the last
+///edges of the shortest paths.
 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
 ///
 typedef typename Graph::template NodeMap<typename GR::Edge> PredMap;
 ///Instantiates a PredMap.
 return new PredMap(G);
 }
 ///\brief The type of the map that stores the last but one
 ///nodes of the shortest paths.
 ///
+///The type of the map that stores the last but one
+///nodes of the shortest paths.
 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
 ///
 typedef typename Graph::template NodeMap<typename GR::Node> PredNodeMap;
 ///Instantiates a PredNodeMap.
 return new PredNodeMap(G);
 }
 ///The type of the map that stores whether a nodes is reached.
+///The type of the map that stores whether a nodes is reached.
 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
 ///By default it is a NullMap.
 ///\todo If it is set to a real map, Dijkstra::reached() should read this.
 ///\todo named parameter to set this type, function to read and write.
 typedef NullMap<typename Graph::Node,bool> ReachedMap;
 {
 return new ReachedMap();
 }
 ///The type of the map that stores the dists of the nodes.
+///The type of the map that stores the dists of the nodes.
 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
 ///
 typedef typename Graph::template NodeMap<typename LM::Value> DistMap;
 ///Instantiates a DistMap.
 };
 /// Default traits used by \ref DijkstraWizard
-/// To make it easier to use Dijkstra algorithm we created a wizard class.
+/// To make it easier to use Dijkstra algorithm we have created a wizard class.
-/// This \ref DijkstraWizard class also needs default traits.
+/// 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>
 {
 /// It uses the functions and features of the plain \ref Dijkstra,
 /// but it is much more simple 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 \Dijkstra
+/// and not on templatable built-in classes. When using the plain \ref Dijkstra
-/// the new class with the modified type comes from the original by using the ::
+/// the new class with the modified type comes from the original class by using the ::
-/// operator. In this case only a function have to be called and it will
+/// 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.
 public:
 /// Constructor.
 DijkstraWizard() : TR() {}
 /// Constructor that requires parameters.
+/// Constructor that requires parameters.
 /// These parameters will be the default values for the traits class.
 DijkstraWizard(const Graph &g,const LengthMap &l, Node s=INVALID) :
 TR(g,l,s) {}
 ///Copy constructor
 if(_predNode) Dij.predNodeMap(*(PredNodeMap*)_predNode);
 if(_dist) Dij.distMap(*(DistMap*)_dist);
 Dij.run(*(Node*)_source);
 }
-///Runs Dijkstra algorithm from a given node.
+///Runs Dijkstra algorithm from the given node.
-///Runs Dijkstra algorithm from a given node.
+///Runs Dijkstra algorithm from the given node.
 ///\param s is the given source.
 void run(Node s)
 {
 _source=(void *)&s;
 run();
 };
 /// \ref named-templ-param "Named parameter" function for setting PredMap type
 /// \ref named-templ-param "Named parameter" function for setting PredMap type
+///
 template<class T>
 DijkstraWizard<DefPredMapBase<T> > predMap(const T &t)
 {
 _pred=(void *)&t;
 return DijkstraWizard<DefPredMapBase<T> >(*this);
 };
 /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
 /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
+///
 template<class T>
 DijkstraWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t)
 {
 _predNode=(void *)&t;
 return DijkstraWizard<DefPredNodeMapBase<T> >(*this);
 };
 /// \ref named-templ-param "Named parameter" function for setting DistMap type
 /// \ref named-templ-param "Named parameter" function for setting DistMap type
+///
 template<class T>
 DijkstraWizard<DefDistMapBase<T> > distMap(const T &t)
 {
 _dist=(void *)&t;
 return DijkstraWizard<DefDistMapBase<T> >(*this);

changeset 1124	12623f7ecb37
parent 1123	a2e93889a604
child 1125	377e240b050f