COIN-OR::LEMON - Graph Library

Changes in / [196:420013ff029b:195:aa45ff44fcf3] in lemon-main


Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/kruskal.h

    r194 r167  
    3333///\ingroup spantree
    3434///\file
    35 ///\brief Kruskal's algorithm to compute a minimum cost spanning tree
     35///\brief Kruskal's algorithm to compute a minimum cost tree
    3636///
    37 ///Kruskal's algorithm to compute a minimum cost spanning tree.
     37///Kruskal's algorithm to compute a minimum cost tree.
    3838///
    3939
     
    252252  /// \ingroup spantree
    253253  ///
    254   /// \brief Kruskal algorithm to find a minimum cost spanning tree of
    255   /// a graph.
    256   ///
    257   /// This function runs Kruskal's algorithm to find a minimum cost
    258   /// spanning tree.
     254  /// \brief Kruskal's algorithm to find a minimum cost tree of a graph.
     255  ///
     256  /// This function runs Kruskal's algorithm to find a minimum cost tree.
    259257  /// Due to some C++ hacking, it accepts various input and output types.
    260258  ///
     
    265263  /// undirected by disregarding the direction of the arcs.
    266264  ///
    267   /// \param in This object is used to describe the arc/edge costs.
    268   /// It can be one of the following choices.
     265  /// \param in This object is used to describe the arc costs. It can be one
     266  /// of the following choices.
    269267  /// - An STL compatible 'Forward Container' with
    270   /// <tt>std::pair<GR::Arc,X></tt> or
    271   /// <tt>std::pair<GR::Edge,X></tt> as its <tt>value_type</tt>, where
    272   /// \c X is the type of the costs. The pairs indicates the arcs/edges
     268  /// <tt>std::pair<GR::Edge,X></tt> or
     269  /// <tt>std::pair<GR::Arc,X></tt> as its <tt>value_type</tt>, where
     270  /// \c X is the type of the costs. The pairs indicates the arcs
    273271  /// along with the assigned cost. <em>They must be in a
    274272  /// cost-ascending order.</em>
    275   /// - Any readable arc/edge map. The values of the map indicate the
    276   /// arc/edge costs.
    277   ///
    278   /// \retval out Here we also have a choice.
    279   /// - It can be a writable \c bool arc/edge map. After running the
    280   /// algorithm it will contain the found minimum cost spanning
    281   /// tree: the value of an arc/edge will be set to \c true if it belongs
     273  /// - Any readable Arc map. The values of the map indicate the arc costs.
     274  ///
     275  /// \retval out Here we also have a choise.
     276  /// - It can be a writable \c bool arc map.  After running the
     277  /// algorithm this will contain the found minimum cost spanning
     278  /// tree: the value of an arc will be set to \c true if it belongs
    282279  /// to the tree, otherwise it will be set to \c false. The value of
    283   /// each arc/edge will be set exactly once.
     280  /// each arc will be set exactly once.
    284281  /// - It can also be an iteraror of an STL Container with
    285   /// <tt>GR::Arc</tt> or <tt>GR::Edge</tt> as its
     282  /// <tt>GR::Edge</tt> or <tt>GR::Arc</tt> as its
    286283  /// <tt>value_type</tt>.  The algorithm copies the elements of the
    287284  /// found tree into this sequence.  For example, if we know that the
     
    294291  /// Or if we don't know in advance the size of the tree, we can
    295292  /// write this. 
    296   ///\code
    297   /// std::vector<Arc> tree;
     293  ///\code std::vector<Arc> tree;
    298294  /// kruskal(g,cost,std::back_inserter(tree));
    299295  ///\endcode
    300296  ///
    301   /// \return The total cost of the found spanning tree.
    302   ///
    303   /// \warning If Kruskal runs on an be consistent of using the same
     297  /// \return The total cost of the found tree.
     298  ///
     299  /// \warning If kruskal runs on an be consistent of using the same
    304300  /// Arc type for input and output.
    305301  ///
Note: See TracChangeset for help on using the changeset viewer.