[Lemon-commits] [lemon_svn] alpar: r1348 - in hugo/trunk/src/lemon: . concept

[Lemon SVN]

Author: alpar
Date: Fri Nov  5 08:26:20 2004
New Revision: 1348

Modified:
   hugo/trunk/src/lemon/concept/graph_component.h
   hugo/trunk/src/lemon/dimacs.h
   hugo/trunk/src/lemon/graph_utils.h
   hugo/trunk/src/lemon/xy.h

Log:
Doc improvements

Modified: hugo/trunk/src/lemon/concept/graph_component.h
==============================================================================
--- hugo/trunk/src/lemon/concept/graph_component.h	(original)
+++ hugo/trunk/src/lemon/concept/graph_component.h	Fri Nov  5 08:26:20 2004
@@ -34,7 +34,7 @@
     /// Skeleton class for graph Node and Edge
 
     /// \note Because Node and Edge are forbidden to inherit from the same
-    /// base class, this is a template. For Node you shoul instantiate it
+    /// base class, this is a template. For Node you should instantiate it
     /// with character 'n' and for Edge with 'e'.
 
     template<char Ch>

Modified: hugo/trunk/src/lemon/dimacs.h
==============================================================================
--- hugo/trunk/src/lemon/dimacs.h	(original)
+++ hugo/trunk/src/lemon/dimacs.h	Fri Nov  5 08:26:20 2004
@@ -35,7 +35,10 @@
   /// Dimacs min cost flow reader function.
 
   /// This function reads a min cost flow instance from dimacs format,
-  /// i.e. from dimacs files having a line starting with \c p \c "min".
+  /// i.e. from dimacs files having a line starting with
+  /// \code
+  /// p "min"
+  /// \endcode
   /// At the beginning \c g is cleared by \c g.clear(). The edge
   /// capacities are written to \c capacity, \c s and \c t are set to
   /// the source and the target nodes resp. and the cost of the edges
@@ -112,8 +115,11 @@
   /// Dimacs max flow reader function.
 
   /// This function reads a max flow instance from dimacs format,
-  /// i.e. from dimacs files having a line starting with \c p \c
-  /// "max".  At the beginning \c g is cleared by \c g.clear(). The
+  /// i.e. from dimacs files having a line starting with
+  /// \code
+  /// p "max"
+  /// \endcode
+  ///At the beginning \c g is cleared by \c g.clear(). The
   /// edge capacities are written to \c capacity and \c s and \c t are
   /// set to the source and the target nodes.
   ///
@@ -129,7 +135,10 @@
   /// Dimacs shortest path reader function.
 
   /// This function reads a shortest path instance from dimacs format,
-  /// i.e. from dimacs files having a line starting with \c p \c "sp".
+  /// i.e. from dimacs files having a line starting with
+  /// \code
+  /// p "sp"
+  /// \endcode
   /// At the beginning \c g is cleared by \c g.clear(). The edge
   /// capacities are written to \c capacity and \c s is set to the
   /// source node.
@@ -162,7 +171,11 @@
 
   /// This function reads a graph without any designated nodes and
   /// maps from dimacs format, i.e. from dimacs files having a line
-  /// starting with \c p \c "mat".  At the beginning \c g is cleared
+  /// starting with
+  /// \code
+  /// p "mat"
+  /// \endcode
+  /// At the beginning \c g is cleared
   /// by \c g.clear().
   ///
   /// \author Marton Makai

Modified: hugo/trunk/src/lemon/graph_utils.h
==============================================================================
--- hugo/trunk/src/lemon/graph_utils.h	(original)
+++ hugo/trunk/src/lemon/graph_utils.h	Fri Nov  5 08:26:20 2004
@@ -25,6 +25,9 @@
 ///\file
 ///\brief Graph utilities.
 ///
+///\todo Please
+///revise the documentation.
+///
 
 
 namespace lemon {
@@ -52,7 +55,7 @@
   ///
   /// This function counts the nodes in the graph.
   /// The complexity of the function is O(n) but for some
-  /// graph structure it is specialized to O(1).
+  /// graph structure it is specialized to run in O(1).
 
   template <typename Graph>
   inline int countNodes(const Graph& _g) {
@@ -63,7 +66,7 @@
   ///
   /// This function counts the edges in the graph.
   /// The complexity of the function is O(e) but for some
-  /// graph structure it is specialized to O(1).
+  /// graph structure it is specialized to run in O(1).
   template <typename Graph>
   inline int countEdges(const Graph& _g) {
     return countItems<Graph, typename Graph::EdgeIt>(_g);
@@ -73,7 +76,7 @@
   ///
   /// This function counts the symmetric edges in the graph.
   /// The complexity of the function is O(e) but for some
-  /// graph structure it is specialized to O(1).
+  /// graph structure it is specialized to run in O(1).
   template <typename Graph>
   inline int countSymEdges(const Graph& _g) {
     return countItems<Graph, typename Graph::SymEdgeIt>(_g);
@@ -87,12 +90,20 @@
     }
     return num;
   }
+  
+  ///\e
 
+  ///\todo Please document.
+  ///
   template <typename Graph>
   inline int countOutEdges(const Graph& _g,  const typename Graph::Node& _n) {
     return countNodeDegree<Graph, typename Graph::OutEdgeIt>(_g, _n);
   }
 
+  ///\e
+
+  ///\todo Please document.
+  ///
   template <typename Graph>
   inline int countInEdges(const Graph& _g,  const typename Graph::Node& _n) {
     return countNodeDegree<Graph, typename Graph::InEdgeIt>(_g, _n);

Modified: hugo/trunk/src/lemon/xy.h
==============================================================================
--- hugo/trunk/src/lemon/xy.h	(original)
+++ hugo/trunk/src/lemon/xy.h	Fri Nov  5 08:26:20 2004
@@ -50,6 +50,8 @@
 
     public:
 
+      typedef T ValueType;
+
       T x,y;     
       
       ///Default constructor: both coordinates become 0