Dijkstra documentation is getting ready, but one decision is missing about naming conventions about named_params
authorhegyi
Sat, 05 Feb 2005 13:40:01 +0000
changeset 112412623f7ecb37
parent 1123 a2e93889a604
child 1125 377e240b050f
Dijkstra documentation is getting ready, but one decision is missing about naming conventions about named_params
src/work/alpar/dijkstra.h
     1.1 --- a/src/work/alpar/dijkstra.h	Fri Feb 04 15:32:11 2005 +0000
     1.2 +++ b/src/work/alpar/dijkstra.h	Sat Feb 05 13:40:01 2005 +0000
     1.3 @@ -48,8 +48,8 @@
     1.4      typedef GR Graph;
     1.5      ///The type of the map that stores the edge lengths.
     1.6  
     1.7 +    ///The type of the map that stores the edge lengths.
     1.8      ///It must meet the \ref concept::ReadMap "ReadMap" concept.
     1.9 -    ///
    1.10      typedef LM LengthMap;
    1.11      //The type of the length of the edges.
    1.12      typedef typename LM::Value Value;
    1.13 @@ -67,6 +67,8 @@
    1.14      ///\brief The type of the map that stores the last
    1.15      ///edges of the shortest paths.
    1.16      /// 
    1.17 +    ///The type of the map that stores the last
    1.18 +    ///edges of the shortest paths.
    1.19      ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    1.20      ///
    1.21      typedef typename Graph::template NodeMap<typename GR::Edge> PredMap;
    1.22 @@ -82,6 +84,8 @@
    1.23      ///\brief The type of the map that stores the last but one
    1.24      ///nodes of the shortest paths.
    1.25      ///
    1.26 +    ///The type of the map that stores the last but one
    1.27 +    ///nodes of the shortest paths.
    1.28      ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    1.29      ///
    1.30      typedef typename Graph::template NodeMap<typename GR::Node> PredNodeMap;
    1.31 @@ -96,6 +100,7 @@
    1.32  
    1.33      ///The type of the map that stores whether a nodes is reached.
    1.34   
    1.35 +    ///The type of the map that stores whether a nodes is reached.
    1.36      ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    1.37      ///By default it is a NullMap.
    1.38      ///\todo If it is set to a real map, Dijkstra::reached() should read this.
    1.39 @@ -111,6 +116,7 @@
    1.40      }
    1.41      ///The type of the map that stores the dists of the nodes.
    1.42   
    1.43 +    ///The type of the map that stores the dists of the nodes.
    1.44      ///It must meet the \ref concept::WriteMap "WriteMap" concept.
    1.45      ///
    1.46      typedef typename Graph::template NodeMap<typename LM::Value> DistMap;
    1.47 @@ -509,8 +515,8 @@
    1.48  
    1.49    /// Default traits used by \ref DijkstraWizard
    1.50  
    1.51 -  /// To make it easier to use Dijkstra algorithm we created a wizard class.
    1.52 -  /// This \ref DijkstraWizard class also needs default traits.
    1.53 +  /// To make it easier to use Dijkstra algorithm we have created a wizard class.
    1.54 +  /// This \ref DijkstraWizard class needs default traits, as well as the \ref Dijkstra class.
    1.55    /// The \ref DijkstraWizardBase is a class to be the default traits of the
    1.56    /// \ref DijkstraWizard class.
    1.57    template<class GR,class LM>
    1.58 @@ -564,9 +570,9 @@
    1.59    ///
    1.60    /// Simplicity means that the way to change the types defined
    1.61    /// in the traits class is based on functions that returns the new class
    1.62 -  /// and not on templatable built-in classes. When using the plain \Dijkstra
    1.63 -  /// the new class with the modified type comes from the original by using the ::
    1.64 -  /// operator. In this case only a function have to be called and it will
    1.65 +  /// and not on templatable built-in classes. When using the plain \ref Dijkstra
    1.66 +  /// the new class with the modified type comes from the original class by using the ::
    1.67 +  /// operator. In the case of \ref DijkstraWizard only a function have to be called and it will
    1.68    /// return the needed class.
    1.69    ///
    1.70    /// It does not have own \ref run method. When its \ref run method is called
    1.71 @@ -608,6 +614,8 @@
    1.72      DijkstraWizard() : TR() {}
    1.73  
    1.74      /// Constructor that requires parameters.
    1.75 +
    1.76 +    /// Constructor that requires parameters.
    1.77      /// These parameters will be the default values for the traits class.
    1.78      DijkstraWizard(const Graph &g,const LengthMap &l, Node s=INVALID) :
    1.79        TR(g,l,s) {}
    1.80 @@ -631,9 +639,9 @@
    1.81        Dij.run(*(Node*)_source);
    1.82      }
    1.83  
    1.84 -    ///Runs Dijkstra algorithm from a given node.
    1.85 +    ///Runs Dijkstra algorithm from the given node.
    1.86  
    1.87 -    ///Runs Dijkstra algorithm from a given node.
    1.88 +    ///Runs Dijkstra algorithm from the given node.
    1.89      ///\param s is the given source.
    1.90      void run(Node s)
    1.91      {
    1.92 @@ -651,6 +659,7 @@
    1.93      /// \ref named-templ-param "Named parameter" function for setting PredMap type
    1.94  
    1.95      /// \ref named-templ-param "Named parameter" function for setting PredMap type
    1.96 +    ///
    1.97      template<class T>
    1.98      DijkstraWizard<DefPredMapBase<T> > predMap(const T &t) 
    1.99      {
   1.100 @@ -669,6 +678,7 @@
   1.101      /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
   1.102  
   1.103      /// \ref named-templ-param "Named parameter" function for setting PredNodeMap type
   1.104 +    ///
   1.105      template<class T>
   1.106      DijkstraWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t) 
   1.107      {
   1.108 @@ -686,6 +696,7 @@
   1.109      /// \ref named-templ-param "Named parameter" function for setting DistMap type
   1.110  
   1.111      /// \ref named-templ-param "Named parameter" function for setting DistMap type
   1.112 +    ///
   1.113      template<class T>
   1.114      DijkstraWizard<DefDistMapBase<T> > distMap(const T &t) 
   1.115      {