1.1 --- a/lemon/min_cost_arborescence.h Fri Aug 09 11:07:27 2013 +0200
1.2 +++ b/lemon/min_cost_arborescence.h Sun Aug 11 15:28:12 2013 +0200
1.3 @@ -2,7 +2,7 @@
1.4 *
1.5 * This file is a part of LEMON, a generic C++ optimization library.
1.6 *
1.7 - * Copyright (C) 2003-2008
1.8 + * Copyright (C) 2003-2010
1.9 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
1.10 * (Egervary Research Group on Combinatorial Optimization, EGRES).
1.11 *
1.12 @@ -112,23 +112,24 @@
1.13 /// relatively time consuming process to compute the arc costs if
1.14 /// it is necessary. The default map type is \ref
1.15 /// concepts::Digraph::ArcMap "Digraph::ArcMap<int>".
1.16 - /// \param TR Traits class to set various data types used
1.17 - /// by the algorithm. The default traits class is
1.18 - /// \ref MinCostArborescenceDefaultTraits
1.19 + /// \tparam TR The traits class that defines various types used by the
1.20 + /// algorithm. By default, it is \ref MinCostArborescenceDefaultTraits
1.21 /// "MinCostArborescenceDefaultTraits<GR, CM>".
1.22 + /// In most cases, this parameter should not be set directly,
1.23 + /// consider to use the named template parameters instead.
1.24 #ifndef DOXYGEN
1.25 template <typename GR,
1.26 typename CM = typename GR::template ArcMap<int>,
1.27 typename TR =
1.28 MinCostArborescenceDefaultTraits<GR, CM> >
1.29 #else
1.30 - template <typename GR, typename CM, typedef TR>
1.31 + template <typename GR, typename CM, typename TR>
1.32 #endif
1.33 class MinCostArborescence {
1.34 public:
1.35
1.36 - /// \brief The \ref MinCostArborescenceDefaultTraits "traits class"
1.37 - /// of the algorithm.
1.38 + /// \brief The \ref MinCostArborescenceDefaultTraits "traits class"
1.39 + /// of the algorithm.
1.40 typedef TR Traits;
1.41 /// The type of the underlying digraph.
1.42 typedef typename Traits::Digraph Digraph;
1.43 @@ -435,7 +436,7 @@
1.44 ///
1.45 /// \ref named-templ-param "Named parameter" for setting
1.46 /// \c PredMap type.
1.47 - /// It must meet the \ref concepts::WriteMap "WriteMap" concept,
1.48 + /// It must meet the \ref concepts::WriteMap "WriteMap" concept,
1.49 /// and its value type must be the \c Arc type of the digraph.
1.50 template <class T>
1.51 struct SetPredMap
1.52 @@ -488,8 +489,8 @@
1.53 /// \name Execution Control
1.54 /// The simplest way to execute the algorithm is to use
1.55 /// one of the member functions called \c run(...). \n
1.56 - /// If you need more control on the execution,
1.57 - /// first you must call \ref init(), then you can add several
1.58 + /// If you need better control on the execution,
1.59 + /// you have to call \ref init() first, then you can add several
1.60 /// source nodes with \ref addSource().
1.61 /// Finally \ref start() will perform the arborescence
1.62 /// computation.