Changeset 1123:a2e93889a604 in lemon-0.x for src/work/alpar

Timestamp:

02/04/05 16:32:11 (20 years ago)

Author:

Hegyi Péter

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1522

Message:

Documentation is developing itself, but is not ready yet.

File:

• src/work/alpar/dijkstra.h (modified) (14 diffs)

src/work/alpar/dijkstra.h

@@ -73 +73 @@
     ///Instantiates a PredMap.
  
-    ///\todo Please document...
+    ///This function instantiates a \ref PredMap. 
+    ///\param G is the graph, to which we would like to define the PredMap.
     ///\todo The graph alone may be insufficient for the initialization
     static PredMap *createPredMap(const GR &G) 
@@ -87 +88 @@
     ///Instantiates a PredNodeMap.
  
-    ///\todo Please document...
-    ///
+    ///This function instantiates a \ref PredNodeMap. 
+    ///\param G is the graph, to which we would like to define the \ref PredNodeMap
     static PredNodeMap *createPredNodeMap(const GR &G)
     {
@@ -103 +104 @@
     ///Instantiates a ReachedMap.
  
-    ///\todo Please document...
-    ///
+    ///This function instantiates a \ref ReachedMap. 
+    ///\param G is the graph, to which we would like to define the \ref ReachedMap
     static ReachedMap *createReachedMap(const GR &G)
     {
@@ -116 +117 @@
     ///Instantiates a DistMap.
  
-    ///\todo Please document...
-    ///
+    ///This function instantiates a \ref DistMap. 
+    ///\param G is the graph, to which we would like to define the \ref DistMap
     static DistMap *createDistMap(const GR &G)
     {
@@ -507 +508 @@
   };
 
+  /// Default traits used by \ref DijkstraWizard
+
+  /// To make it easier to use Dijkstra algorithm we created a wizard class.
+  /// This \ref DijkstraWizard class also needs default traits.
+  /// 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>
@@ -526 +533 @@
     void *_source;
 
+    /// Type of the nodes in the graph.
     typedef typename Base::Graph::Node Node;
 
     public:
+    /// Constructor.
+    
+    /// This constructor does not require parameters, therefore it initiates
+    /// all of the attributes to default values (0, INVALID).
     DijkstraWizardBase() : _g(0), _length(0), _pred(0), _predNode(0),
                        _dist(0), _source(INVALID) {}
 
+    /// Constructor.
+    
+    /// This constructor requires some parameters, listed in the parameters list.
+    /// Others are initiated to 0.
+    /// \param g is the initial value of  \ref _g
+    /// \param l is the initial value of  \ref _length
+    /// \param s is the initial value of  \ref _source
     DijkstraWizardBase(const GR &g,const LM &l, Node s=INVALID) :
       _g((void *)&g), _length((void *)&l), _pred(0), _predNode(0),
@@ -538 +557 @@
   };
   
-  ///\e
-
-  ///\e
+  /// A class to make easier the usage of Dijkstra algorithm
+
+  /// 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.
   ///
+  /// 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
+  /// the new class with the modified type comes from the original by using the ::
+  /// operator. In this case 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.
   template<class TR>
   class DijkstraWizard : public TR
@@ -547 +578 @@
     typedef TR Base;
 
-    //The type of the underlying graph.
+    ///The type of the underlying graph.
     typedef typename TR::Graph Graph;
     //\e
@@ -558 +589 @@
     typedef typename Graph::OutEdgeIt OutEdgeIt;
     
-    //The type of the map that stores the edge lengths.
+    ///The type of the map that stores the edge lengths.
     typedef typename TR::LengthMap LengthMap;
-    //The type of the length of the edges.
+    ///The type of the length of the edges.
     typedef typename LengthMap::Value Value;
-    //\brief The type of the map that stores the last
-    //edges of the shortest paths.
+    ///\brief The type of the map that stores the last
+    ///edges of the shortest paths.
     typedef typename TR::PredMap PredMap;
-    //\brief The type of the map that stores the last but one
-    //nodes of the shortest paths.
+    ///\brief The type of the map that stores the last but one
+    ///nodes of the shortest paths.
     typedef typename TR::PredNodeMap PredNodeMap;
-    //The type of the map that stores the dists of the nodes.
+    ///The type of the map that stores the dists of the nodes.
     typedef typename TR::DistMap DistMap;
 
-    //The heap type used by the dijkstra algorithm.
+    ///The heap type used by the dijkstra algorithm.
     typedef typename TR::Heap Heap;
 public:
+    /// Constructor.
     DijkstraWizard() : TR() {}
 
+    /// 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
     DijkstraWizard(const TR &b) : TR(b) {}
 
     ~DijkstraWizard() {}
 
-    ///\e
+    ///Runs Dijkstra algorithm from a given node.
+    
+    ///Runs Dijkstra algorithm from a given node.
+    ///The node can be given by the \ref source function.
     void run()
     {
@@ -594 +632 @@
     }
 
-    ///\e
+    ///Runs Dijkstra algorithm from a given node.
+
+    ///Runs Dijkstra algorithm from a given node.
+    ///\param s is the given source.
     void run(Node s)
     {
@@ -608 +649 @@
     };
     
-    ///\e
+    /// \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) 
@@ -624 +667 @@
     };
     
-    ///\e
+    /// \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) 
@@ -639 +684 @@
     };
     
-    ///\e
+    /// \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) 
@@ -647 +694 @@
     }
     
-    ///\e
+    /// Sets the source node, from which the Dijkstra algorithm runs.
+
+    /// Sets the source node, from which the Dijkstra algorithm runs.
+    /// \param s is the source node.
     DijkstraWizard<TR> &source(Node s) 
     {