Changes in doc. (New module name for array/vector maps added.)
1.1 --- a/doc/groups.dox Thu Sep 02 11:20:49 2004 +0000
1.2 +++ b/doc/groups.dox Thu Sep 02 15:13:21 2004 +0000
1.3 @@ -33,6 +33,15 @@
1.4 */
1.5
1.6 /**
1.7 +@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
1.8 +@ingroup auxdat
1.9 +\brief Tools to Make It Easier to Make Graph Maps.
1.10 +
1.11 +This group describes the tools that makes it easier to make graph maps that
1.12 +dynamically update with the graph changes.
1.13 +*/
1.14 +
1.15 +/**
1.16 @defgroup gwrappers Wrapper Classes for Graphs
1.17 \brief This group contains several wrapper classes for graphs
1.18 @ingroup graphs
2.1 --- a/src/hugo/array_map_factory.h Thu Sep 02 11:20:49 2004 +0000
2.2 +++ b/src/hugo/array_map_factory.h Thu Sep 02 15:13:21 2004 +0000
2.3 @@ -6,8 +6,17 @@
2.4
2.5 #include <hugo/extended_pair.h>
2.6
2.7 +///\ingroup graphmapfactory
2.8 +///\file
2.9 +///\brief Graph maps that construates and destruates
2.10 +///their elements dynamically.
2.11 +
2.12 namespace hugo {
2.13
2.14 +/// \addtogroup graphmapfactory
2.15 +/// @{
2.16 +
2.17 + ///.
2.18 template <typename MapRegistry> class ArrayMapFactory {
2.19
2.20 public:
2.21 @@ -362,6 +371,10 @@
2.22 Allocator allocator;
2.23 };
2.24 };
2.25 +
2.26 +/// @}
2.27 +
2.28 +
2.29 }
2.30
2.31 #endif
3.1 --- a/src/hugo/dijkstra.h Thu Sep 02 11:20:49 2004 +0000
3.2 +++ b/src/hugo/dijkstra.h Thu Sep 02 15:13:21 2004 +0000
3.3 @@ -87,7 +87,7 @@
3.4 //The source node of the last execution.
3.5 Node source;
3.6
3.7 - ///Initialize maps
3.8 + ///Initializes the maps.
3.9
3.10 ///\todo Error if \c G or are \c NULL. What about \c length?
3.11 ///\todo Better memory allocation (instead of new).
3.12 @@ -132,6 +132,8 @@
3.13
3.14 ///Sets the graph the algorithm will run on.
3.15 ///\return <tt> (*this) </tt>
3.16 + ///\bug What about maps?
3.17 + ///\todo It may be unnecessary
3.18 Dijkstra &setGraph(const Graph &_G)
3.19 {
3.20 G = &_G;
3.21 @@ -273,7 +275,7 @@
3.22 ///Returns the 'previous edge' of the shortest path tree.
3.23
3.24 ///For a node \c v it returns the 'previous edge' of the shortest path tree,
3.25 - ///i.e. it returns the last edge from a shortest path from the root to \c
3.26 + ///i.e. it returns the last edge of a shortest path from the root to \c
3.27 ///v. It is \ref INVALID
3.28 ///if \c v is unreachable from the root or if \c v=s. The
3.29 ///shortest path tree used here is equal to the shortest path tree used in
3.30 @@ -322,11 +324,6 @@
3.31
3.32 };
3.33
3.34 -
3.35 - // **********************************************************************
3.36 - // IMPLEMENTATIONS
3.37 - // **********************************************************************
3.38 -
3.39 /// @}
3.40
3.41 } //END OF NAMESPACE HUGO
4.1 --- a/src/hugo/map_defines.h Thu Sep 02 11:20:49 2004 +0000
4.2 +++ b/src/hugo/map_defines.h Thu Sep 02 15:13:21 2004 +0000
4.3 @@ -2,6 +2,13 @@
4.4 #ifndef MAP_DEFINES_H
4.5 #define MAP_DEFINES_H
4.6
4.7 +///\ingroup graphmapfactory
4.8 +///\file
4.9 +///\brief Defines to help creating graph maps.
4.10 +
4.11 +/// \addtogroup graphmapfactory
4.12 +/// @{
4.13 +
4.14 /** Creates the EdgeMapRegistry type an declare a mutable instance
4.15 * named edge_maps.
4.16 */
4.17 @@ -209,4 +216,7 @@
4.18 } \
4.19 };
4.20
4.21 +
4.22 +/// @}
4.23 +
4.24 #endif
5.1 --- a/src/hugo/map_registry.h Thu Sep 02 11:20:49 2004 +0000
5.2 +++ b/src/hugo/map_registry.h Thu Sep 02 15:13:21 2004 +0000
5.3 @@ -4,10 +4,17 @@
5.4
5.5 #include <vector>
5.6
5.7 +///\ingroup graphmapfactory
5.8 +///\file
5.9 +///\brief Map registry for graph maps.
5.10 +
5.11 using namespace std;
5.12
5.13 namespace hugo {
5.14
5.15 +/// \addtogroup graphmapfactory
5.16 +/// @{
5.17 +
5.18 /**
5.19 * Registry class to register edge or node maps into the graph. The
5.20 * registry helps you to implement an observer pattern. If you add
5.21 @@ -261,6 +268,10 @@
5.22 }
5.23 };
5.24
5.25 +
5.26 +/// @}
5.27 +
5.28 +
5.29 }
5.30
5.31 #endif
6.1 --- a/src/hugo/mincostflows.h Thu Sep 02 11:20:49 2004 +0000
6.2 +++ b/src/hugo/mincostflows.h Thu Sep 02 15:13:21 2004 +0000
6.3 @@ -89,7 +89,7 @@
6.4
6.5 //To store the flow
6.6 EdgeIntMap flow;
6.7 - //To store the potentila (dual variables)
6.8 + //To store the potential (dual variables)
6.9 typedef typename Graph::template NodeMap<Length> PotentialMap;
6.10 PotentialMap potential;
6.11
7.1 --- a/src/hugo/vector_map_factory.h Thu Sep 02 11:20:49 2004 +0000
7.2 +++ b/src/hugo/vector_map_factory.h Thu Sep 02 15:13:21 2004 +0000
7.3 @@ -6,8 +6,15 @@
7.4
7.5 #include <hugo/extended_pair.h>
7.6
7.7 +///\ingroup graphmapfactory
7.8 +///\file
7.9 +///\brief Vector based graph maps.
7.10 +
7.11 namespace hugo {
7.12 -
7.13 +
7.14 + /// \addtogroup graphmapfactory
7.15 + /// @{
7.16 +
7.17 /** The VectorMapFactory template class is a factory class
7.18 * to create maps for the edge and nodes. This map factory
7.19 * use the std::vector to implement the container function.
7.20 @@ -333,6 +340,10 @@
7.21
7.22 };
7.23
7.24 +
7.25 + /// @}
7.26 +
7.27 +
7.28 }
7.29
7.30 #endif