Changeset 1603:5ad84fbadf2b in lemon-0.x

Timestamp:

07/28/05 21:04:43 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

More docs

File:

• lemon/kruskal.h (modified) (3 diffs)

lemon/kruskal.h

@@ -75 +75 @@
   /// 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
@@ -88 +88 @@
   ///
   /// \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
@@ -388 +393 @@
 //   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