Changeset 242:b255f25ad394 in lemon-0.x for src/work/alpar/dijkstra

Timestamp:

03/24/04 14:06:06 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

DocFixes?

Location:

src/work/alpar/dijkstra

Files:

• bin_heap.hh (modified) (1 diff)
• dijkstra.h (modified) (5 diffs)
• fib_heap.h (modified) (2 diffs)

src/work/alpar/dijkstra/bin_heap.hh

@@ -59 +59 @@
 #ifndef BIN_HEAP_HH
 #define BIN_HEAP_HH
+
+///\file
+///\brief Binary Heap implementation.
 
 #include <vector>

src/work/alpar/dijkstra/dijkstra.h

@@ -1 +1 @@
 // -*- C++ -*-
+
 /* 
  *template <Graph, T, Heap=FibHeap, LengthMap=Graph::EdgeMap<T> >
@@ -26 +27 @@
 #ifndef HUGO_DIJKSTRA_H
 #define HUGO_DIJKSTRA_H
+
+///\file
+///\brief Dijkstra algorithm.
 
 #include <fib_heap.h>
@@ -44 +48 @@
   ///The type of the length is determined by the \c ValueType of the length map.
   ///
-  ///It is also posible to change the underlying priority heap.
+  ///It is also possible to change the underlying priority heap.
   ///
   ///\param Graph The graph type the algorithm runs on.
-  ///\param LengthMap This read-only EdgeMap determines the
+  ///\param LengthMap This read-only
+  ///EdgeMap
+  ///determines the
   ///lengths of the edges. It is read once for each edge, so the map
   ///may involve in relatively time consuming process to compute the edge
-  ///length if it is necessary.
+  ///length if it is necessary. The default map type is
+  ///\ref GraphSkeleton::EdgeMap "Graph::EdgeMap<int>"
   ///\param Heap The heap type used by the %Dijkstra
   ///algorithm. The default
   ///is using \ref BinHeap "binary heap".
+  
+#ifdef DOXYGEN
+  template <typename Graph,
+            typename LengthMap,
+            typename Heap>
+#else
   template <typename Graph,
             typename LengthMap=typename Graph::EdgeMap<int>,
@@ -59 +72 @@
                                    typename LengthMap::ValueType, 
                                    typename Graph::NodeMap<int> > >
+#endif
   class Dijkstra{
   public:
@@ -136 +150 @@
     //    bool reached(Node v) { return reach[v]; }
 
-    ///Chechs if a node is reachable from the source.
+    ///Checks if a node is reachable from the source.
 
     ///Returns \c true if \c v is reachable from the source.

src/work/alpar/dijkstra/fib_heap.h

@@ -52 +52 @@
 #define FIB_HEAP_H
 
+///\file
+///\brief Fibonacci Heap implementation.
+
 #include <vector>
 #include <functional>
@@ -74 +77 @@
 
     ///\todo It is use nowhere
-    ///\todo It doesn't conforms to the naming conventions.
+    ///\todo It doesn't conform to the naming conventions.
   public:
     enum state_enum {