[Lemon-commits] [lemon_svn] alpar: r1078 - in hugo/trunk: doc src/hugo

[Lemon SVN]

Author: alpar
Date: Thu Sep  2 17:13:21 2004
New Revision: 1078

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/src/hugo/array_map_factory.h
   hugo/trunk/src/hugo/dijkstra.h
   hugo/trunk/src/hugo/map_defines.h
   hugo/trunk/src/hugo/map_registry.h
   hugo/trunk/src/hugo/mincostflows.h
   hugo/trunk/src/hugo/vector_map_factory.h

Log:
Changes in doc. (New module name for array/vector maps added.)

Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Thu Sep  2 17:13:21 2004
@@ -33,6 +33,15 @@
 */
 
 /**
+ at defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
+ at ingroup auxdat
+\brief Tools to Make It Easier to Make Graph Maps.
+
+This group describes the tools that makes it easier to make graph maps that
+dynamically update with the graph changes.
+*/
+
+/**
 @defgroup gwrappers Wrapper Classes for Graphs
 \brief This group contains several wrapper classes for graphs
 @ingroup graphs

Modified: hugo/trunk/src/hugo/array_map_factory.h
==============================================================================
--- hugo/trunk/src/hugo/array_map_factory.h	(original)
+++ hugo/trunk/src/hugo/array_map_factory.h	Thu Sep  2 17:13:21 2004
@@ -6,8 +6,17 @@
 
 #include <hugo/extended_pair.h>
 
+///\ingroup graphmapfactory
+///\file
+///\brief Graph maps that construates and destruates
+///their elements dynamically.
+
 namespace hugo {
 	
+/// \addtogroup graphmapfactory
+/// @{
+
+  ///.
   template <typename MapRegistry> class ArrayMapFactory {
 		
   public:
@@ -362,6 +371,10 @@
       Allocator allocator;
     };		
   };
+  
+/// @}
+  
+
 }
 
 #endif

Modified: hugo/trunk/src/hugo/dijkstra.h
==============================================================================
--- hugo/trunk/src/hugo/dijkstra.h	(original)
+++ hugo/trunk/src/hugo/dijkstra.h	Thu Sep  2 17:13:21 2004
@@ -87,7 +87,7 @@
     //The source node of the last execution.
     Node source;
 
-    ///Initialize maps
+    ///Initializes the maps.
     
     ///\todo Error if \c G or are \c NULL. What about \c length?
     ///\todo Better memory allocation (instead of new).
@@ -132,6 +132,8 @@
 
     ///Sets the graph the algorithm will run on.
     ///\return <tt> (*this) </tt>
+    ///\bug What about maps?
+    ///\todo It may be unnecessary
     Dijkstra &setGraph(const Graph &_G) 
     {
       G = &_G;
@@ -273,7 +275,7 @@
     ///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
+    ///i.e. it returns the last edge of a shortest path from the root to \c
     ///v. It is \ref INVALID
     ///if \c v is unreachable from the root or if \c v=s. The
     ///shortest path tree used here is equal to the shortest path tree used in
@@ -322,11 +324,6 @@
     
   };
   
-
-  // **********************************************************************
-  //  IMPLEMENTATIONS
-  // **********************************************************************
-
 /// @}
   
 } //END OF NAMESPACE HUGO

Modified: hugo/trunk/src/hugo/map_defines.h
==============================================================================
--- hugo/trunk/src/hugo/map_defines.h	(original)
+++ hugo/trunk/src/hugo/map_defines.h	Thu Sep  2 17:13:21 2004
@@ -2,6 +2,13 @@
 #ifndef MAP_DEFINES_H
 #define MAP_DEFINES_H
 
+///\ingroup graphmapfactory
+///\file
+///\brief Defines to help creating graph maps.
+
+/// \addtogroup graphmapfactory
+/// @{
+
 /** Creates the EdgeMapRegistry type an declare a mutable instance 
  *  named edge_maps.
  */
@@ -209,4 +216,7 @@
       } \
     };
 
+  
+/// @}
+  
 #endif

Modified: hugo/trunk/src/hugo/map_registry.h
==============================================================================
--- hugo/trunk/src/hugo/map_registry.h	(original)
+++ hugo/trunk/src/hugo/map_registry.h	Thu Sep  2 17:13:21 2004
@@ -4,10 +4,17 @@
 
 #include <vector>
 
+///\ingroup graphmapfactory
+///\file
+///\brief Map registry for graph maps.
+
 using namespace std;
 
 namespace hugo {
 
+/// \addtogroup graphmapfactory
+/// @{
+
 /** 
  * Registry class to register edge or node maps into the graph. The
  * registry helps you to implement an observer pattern. If you add
@@ -261,6 +268,10 @@
     }
   };
 
+  
+/// @}
+  
+
 }
 
 #endif

Modified: hugo/trunk/src/hugo/mincostflows.h
==============================================================================
--- hugo/trunk/src/hugo/mincostflows.h	(original)
+++ hugo/trunk/src/hugo/mincostflows.h	Thu Sep  2 17:13:21 2004
@@ -89,7 +89,7 @@
 
     //To store the flow
     EdgeIntMap flow; 
-    //To store the potentila (dual variables)
+    //To store the potential (dual variables)
     typedef typename Graph::template NodeMap<Length> PotentialMap;
     PotentialMap potential;
     

Modified: hugo/trunk/src/hugo/vector_map_factory.h
==============================================================================
--- hugo/trunk/src/hugo/vector_map_factory.h	(original)
+++ hugo/trunk/src/hugo/vector_map_factory.h	Thu Sep  2 17:13:21 2004
@@ -6,8 +6,15 @@
 
 #include <hugo/extended_pair.h>
 
-namespace hugo {
+///\ingroup graphmapfactory
+///\file
+///\brief Vector based graph maps.
 
+namespace hugo {
+  
+  /// \addtogroup graphmapfactory
+  /// @{
+  
   /** The VectorMapFactory template class is a factory class
    *  to create maps for the edge and nodes. This map factory
    *  use the std::vector to implement the container function.
@@ -333,6 +340,10 @@
 		
   };
 
+  
+  /// @}
+  
+
 }
 
 #endif