gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Doc improvement for kruskal() (ticket #114)
0 1 0
default
1 file changed with 2 insertions and 3 deletions:
↑ Collapse diff ↑
Show white space 48 line context
... ...
@@ -279,51 +279,50 @@
279 279
  /// - It can be a writable \c bool arc/edge map. After running the
280 280
  /// algorithm it will contain the found minimum cost spanning
281 281
  /// tree: the value of an arc/edge will be set to \c true if it belongs
282 282
  /// to the tree, otherwise it will be set to \c false. The value of
283 283
  /// each arc/edge will be set exactly once.
284 284
  /// - It can also be an iteraror of an STL Container with
285 285
  /// <tt>GR::Arc</tt> or <tt>GR::Edge</tt> as its
286 286
  /// <tt>value_type</tt>.  The algorithm copies the elements of the
287 287
  /// found tree into this sequence.  For example, if we know that the
288 288
  /// spanning tree of the graph \c g has say 53 arcs, then we can
289 289
  /// put its arcs into an STL vector \c tree with a code like this.
290 290
  ///\code
291 291
  /// std::vector<Arc> tree(53);
292 292
  /// kruskal(g,cost,tree.begin());
293 293
  ///\endcode
294 294
  /// Or if we don't know in advance the size of the tree, we can
295 295
  /// write this.
296 296
  ///\code
297 297
  /// std::vector<Arc> tree;
298 298
  /// kruskal(g,cost,std::back_inserter(tree));
299 299
  ///\endcode
300 300
  ///
301 301
  /// \return The total cost of the found spanning tree.
302 302
  ///
303
  /// \warning If Kruskal runs on an be consistent of using the same
304
  /// Arc type for input and output.
305
  ///
303
  /// \note If the input graph is not (weakly) connected, a spanning 
304
  /// forest is calculated instead of a spanning tree.
306 305

	
307 306
#ifdef DOXYGEN
308 307
  template <class Graph, class In, class Out>
309 308
  Value kruskal(GR const& g, const In& in, Out& out)
310 309
#else
311 310
  template <class Graph, class In, class Out>
312 311
  inline typename _kruskal_bits::KruskalValueSelector<In>::Value
313 312
  kruskal(const Graph& graph, const In& in, Out& out)
314 313
#endif
315 314
  {
316 315
    return _kruskal_bits::KruskalInputSelector<Graph, In, Out>::
317 316
      kruskal(graph, in, out);
318 317
  }
319 318

	
320 319

	
321 320

	
322 321

	
323 322
  template <class Graph, class In, class Out>
324 323
  inline typename _kruskal_bits::KruskalValueSelector<In>::Value
325 324
  kruskal(const Graph& graph, const In& in, const Out& out)
326 325
  {
327 326
    return _kruskal_bits::KruskalInputSelector<Graph, In, const Out>::
328 327
      kruskal(graph, in, out);
329 328
  }
0 comments (0 inline)