More docs
authoralpar
Thu, 28 Jul 2005 19:04:43 +0000
changeset 16035ad84fbadf2b
parent 1602 c0d7a9247963
child 1604 4d037c2b66aa
More docs
lemon/kruskal.h
     1.1 --- a/lemon/kruskal.h	Thu Jul 28 17:06:13 2005 +0000
     1.2 +++ b/lemon/kruskal.h	Thu Jul 28 19:04:43 2005 +0000
     1.3 @@ -74,7 +74,7 @@
     1.4    /// <tt>GR::Edge</tt> as its <tt>value_type</tt>.
     1.5    /// The algorithm copies the elements of the found tree into this sequence.
     1.6    /// For example, if we know that the spanning tree of the graph \c g has
     1.7 -  /// say 53 edges then
     1.8 +  /// say 53 edges, then
     1.9    /// we can put its edges into a STL vector \c tree with a code like this.
    1.10    /// \code
    1.11    /// std::vector<Edge> tree(53);
    1.12 @@ -88,6 +88,11 @@
    1.13    ///
    1.14    /// \return The cost of the found tree.
    1.15    ///
    1.16 +  /// \warning If kruskal is run on an \ref undirected graph, be sure that the
    1.17 +  /// map storing the tree is also undirected
    1.18 +  /// (e.g. UndirListGraph::UndirEdgeMap<bool>, otherwise the values of the
    1.19 +  /// half of the edges will not be set.
    1.20 +  ///
    1.21    /// \todo Discuss the case of undirected graphs: In this case the algorithm
    1.22    /// also require <tt>Edge</tt>s instead of <tt>UndirEdge</tt>s, as some
    1.23    /// people would expect. So, one should be careful not to add both of the
    1.24 @@ -387,7 +392,7 @@
    1.25  //   <tt>GR::Edge</tt> as its <tt>value_type</tt>.
    1.26  //   The algorithm copies the elements of the found tree into this sequence.
    1.27  //   For example, if we know that the spanning tree of the graph \c g has
    1.28 -//   say 53 edges then
    1.29 +//   say 53 edges, then
    1.30  //   we can put its edges into a STL vector \c tree with a code like this.
    1.31  //   \code
    1.32  //   std::vector<Edge> tree(53);