[Lemon-commits] [lemon_svn] alpar: r2108 - hugo/trunk/lemon

[Lemon SVN]

Author: alpar
Date: Thu Jul 28 21:04:43 2005
New Revision: 2108

Modified:
   hugo/trunk/lemon/kruskal.h

Log:
More docs

Modified: hugo/trunk/lemon/kruskal.h
==============================================================================
--- hugo/trunk/lemon/kruskal.h	(original)
+++ hugo/trunk/lemon/kruskal.h	Thu Jul 28 21:04:43 2005
@@ -74,7 +74,7 @@
   /// <tt>GR::Edge</tt> as its <tt>value_type</tt>.
   /// The algorithm copies the elements of the found tree into this sequence.
   /// For example, if we know that the spanning tree of the graph \c g has
-  /// say 53 edges then
+  /// say 53 edges, then
   /// we can put its edges into a STL vector \c tree with a code like this.
   /// \code
   /// std::vector<Edge> tree(53);
@@ -88,6 +88,11 @@
   ///
   /// \return The cost of the found tree.
   ///
+  /// \warning If kruskal is run on an \ref undirected graph, be sure that the
+  /// map storing the tree is also undirected
+  /// (e.g. UndirListGraph::UndirEdgeMap<bool>, otherwise the values of the
+  /// half of the edges will not be set.
+  ///
   /// \todo Discuss the case of undirected graphs: In this case the algorithm
   /// also require <tt>Edge</tt>s instead of <tt>UndirEdge</tt>s, as some
   /// people would expect. So, one should be careful not to add both of the
@@ -387,7 +392,7 @@
 //   <tt>GR::Edge</tt> as its <tt>value_type</tt>.
 //   The algorithm copies the elements of the found tree into this sequence.
 //   For example, if we know that the spanning tree of the graph \c g has
-//   say 53 edges then
+//   say 53 edges, then
 //   we can put its edges into a STL vector \c tree with a code like this.
 //   \code
 //   std::vector<Edge> tree(53);