Changeset 584:1d4855f5312e in lemon-0.x for src/hugo/dijkstra.h

Timestamp:

05/08/04 17:58:34 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Some new typedefs.

File:

• src/hugo/dijkstra.h (modified) (8 diffs)

src/hugo/dijkstra.h

@@ -26 +26 @@
   ///It is also possible to change the underlying priority heap.
   ///
-  ///\param Graph The graph type the algorithm runs on.
-  ///\param LengthMap This read-only
+  ///\param GR The graph type the algorithm runs on.
+  ///\param LM This read-only
   ///EdgeMap
   ///determines the
@@ -39 +39 @@
   ///
   ///\author Jacint Szabo
-  ///\todo We need a LengthMap typedef
+  ///\todo We need a typedef-names should be standardized.
+
 #ifdef DOXYGEN
-  template <typename Graph,
-            typename LengthMap,
+  template <typename GR,
+            typename LM,
             typename Heap>
 #else
-  template <typename Graph,
-            typename LengthMap=typename Graph::template EdgeMap<int>,
+  template <typename GR,
+            typename LM=typename GR::template EdgeMap<int>,
             template <class,class,class,class> class Heap = BinHeap >
 #endif
   class Dijkstra{
   public:
+    ///The type of the underlying graph.
+    typedef GR Graph;
     typedef typename Graph::Node Node;
     typedef typename Graph::NodeIt NodeIt;
@@ -56 +59 @@
     typedef typename Graph::OutEdgeIt OutEdgeIt;
     
-    typedef typename LengthMap::ValueType ValueType;
+    ///The type of the length of the edges.
+    typedef typename LM::ValueType ValueType;
+    ///The the type of the map that stores the edge lengths.
+    typedef LM LengthMap;
+    ///\brief The the type of the map that stores the last
+    ///edges of the shortest paths.
     typedef typename Graph::template NodeMap<Edge> PredMap;
+    ///\brief The the type of the map that stores the last but one
+    ///nodes of the shortest paths.
     typedef typename Graph::template NodeMap<Node> PredNodeMap;
+    ///The the type of the map that stores the dists of the nodes.
     typedef typename Graph::template NodeMap<ValueType> DistMap;
 
   private:
     const Graph& G;
-    const LengthMap& length;
+    const LM& length;
     PredMap predecessor;
     PredNodeMap pred_node;
@@ -70 +81 @@
   public :
     
-    Dijkstra(const Graph& _G, const LengthMap& _length) :
+    Dijkstra(const Graph& _G, const LM& _length) :
       G(_G), length(_length), predecessor(_G), pred_node(_G), distance(_G) { }
     
@@ -83 +94 @@
     ValueType dist(Node v) const { return distance[v]; }
 
-    ///Returns the previous edge of the shortest path tree.
-
-    ///For a node \c v it returns the previous edge of the shortest path tree,
+    ///Returns the 'previous edge' of the shortest path tree.
+
+    ///For a node \c v it returns the 'previous edge' of the shortest path tree,
     ///i.e. it returns the last edge from a shortest path from the root to \c
     ///v. It is INVALID if \c v is unreachable from the root or if \c v=s. The
@@ -93 +104 @@
     Edge pred(Node v) const { return predecessor[v]; }
 
-    ///Returns the previous node of the shortest path tree.
-
-    ///For a node \c v it returns the previous node of the shortest path tree,
+    ///Returns the 'previous node' of the shortest path tree.
+
+    ///For a node \c v it returns the 'previous node' of the shortest path tree,
     ///i.e. it returns the last but one node from a shortest path from the
     ///root to \c /v. It is INVALID if \c v is unreachable from the root or if
@@ -147 +158 @@
   ///- The shortest path tree.
   ///- The distance of each node from the root.
-  template <typename Graph, typename LengthMap,
+  template <typename GR, typename LM,
             template<class,class,class,class> class Heap >
-  void Dijkstra<Graph,LengthMap,Heap>::run(Node s) {
+  void Dijkstra<GR,LM,Heap>::run(Node s) {
     
     NodeIt u;
@@ -157 +168 @@
     }
     
-    typename Graph::template NodeMap<int> heap_map(G,-1);
-    
-    typedef Heap<Node, ValueType, typename Graph::template NodeMap<int>,
+    typename GR::template NodeMap<int> heap_map(G,-1);
+    
+    typedef Heap<Node, ValueType, typename GR::template NodeMap<int>,
       std::less<ValueType> > 
       HeapType;