COIN-OR::LEMON - Graph Library

Changeset 584:33c6b6e755cd in lemon-1.2 for lemon/kruskal.h


Ignore:
Timestamp:
04/15/09 02:04:37 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Small doc improvements (#263)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/kruskal.h

    r440 r584  
    249249  /// \ingroup spantree
    250250  ///
    251   /// \brief Kruskal algorithm to find a minimum cost spanning tree of
     251  /// \brief Kruskal's algorithm for finding a minimum cost spanning tree of
    252252  /// a graph.
    253253  ///
    254254  /// This function runs Kruskal's algorithm to find a minimum cost
    255   /// spanning tree.
     255  /// spanning tree of a graph.
    256256  /// Due to some C++ hacking, it accepts various input and output types.
    257257  ///
     
    265265  /// It can be one of the following choices.
    266266  /// - An STL compatible 'Forward Container' with
    267   /// <tt>std::pair<GR::Arc,X></tt> or
    268   /// <tt>std::pair<GR::Edge,X></tt> as its <tt>value_type</tt>, where
    269   /// \c X is the type of the costs. The pairs indicates the arcs/edges
     267  /// <tt>std::pair<GR::Arc,C></tt> or
     268  /// <tt>std::pair<GR::Edge,C></tt> as its <tt>value_type</tt>, where
     269  /// \c C is the type of the costs. The pairs indicates the arcs/edges
    270270  /// along with the assigned cost. <em>They must be in a
    271271  /// cost-ascending order.</em>
     
    274274  ///
    275275  /// \retval out Here we also have a choice.
    276   /// - It can be a writable \c bool arc/edge map. After running the
    277   /// algorithm it will contain the found minimum cost spanning
     276  /// - It can be a writable arc/edge map with \c bool value type. After
     277  /// running the algorithm it will contain the found minimum cost spanning
    278278  /// tree: the value of an arc/edge will be set to \c true if it belongs
    279279  /// to the tree, otherwise it will be set to \c false. The value of
     
    302302
    303303#ifdef DOXYGEN
    304   template <class Graph, class In, class Out>
    305   Value kruskal(GR const& g, const In& in, Out& out)
     304  template <typename Graph, typename In, typename Out>
     305  Value kruskal(const Graph& g, const In& in, Out& out)
    306306#else
    307307  template <class Graph, class In, class Out>
     
    315315
    316316
    317 
    318 
    319317  template <class Graph, class In, class Out>
    320318  inline typename _kruskal_bits::KruskalValueSelector<In>::Value
Note: See TracChangeset for help on using the changeset viewer.