Merge
authorAlpar Juttner <alpar@cs.elte.hu>
Fri, 12 Feb 2010 21:53:15 +0100
changeset 89202109e17027f
parent 890 974c48bda29e
parent 891 75e6020b19b1
child 897 7762cab7f372
Merge
     1.1 --- a/lemon/bellman_ford.h	Thu Feb 11 16:55:54 2010 +0000
     1.2 +++ b/lemon/bellman_ford.h	Fri Feb 12 21:53:15 2010 +0100
     1.3 @@ -171,6 +171,11 @@
     1.4    /// \tparam LEN A \ref concepts::ReadMap "readable" arc map that specifies
     1.5    /// the lengths of the arcs. The default map type is
     1.6    /// \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
     1.7 +  /// \tparam TR The traits class that defines various types used by the
     1.8 +  /// algorithm. By default, it is \ref BellmanFordDefaultTraits
     1.9 +  /// "BellmanFordDefaultTraits<GR, LEN>".
    1.10 +  /// In most cases, this parameter should not be set directly,
    1.11 +  /// consider to use the named template parameters instead.
    1.12  #ifdef DOXYGEN
    1.13    template <typename GR, typename LEN, typename TR>
    1.14  #else
    1.15 @@ -933,6 +938,9 @@
    1.16    ///
    1.17    /// This class should only be used through the \ref bellmanFord()
    1.18    /// function, which makes it easier to use the algorithm.
    1.19 +  ///
    1.20 +  /// \tparam TR The traits class that defines various types used by the
    1.21 +  /// algorithm.
    1.22    template<class TR>
    1.23    class BellmanFordWizard : public TR {
    1.24      typedef TR Base;
     2.1 --- a/lemon/bfs.h	Thu Feb 11 16:55:54 2010 +0000
     2.2 +++ b/lemon/bfs.h	Fri Feb 12 21:53:15 2010 +0100
     2.3 @@ -121,6 +121,11 @@
     2.4    ///
     2.5    ///\tparam GR The type of the digraph the algorithm runs on.
     2.6    ///The default type is \ref ListDigraph.
     2.7 +  ///\tparam TR The traits class that defines various types used by the
     2.8 +  ///algorithm. By default, it is \ref BfsDefaultTraits
     2.9 +  ///"BfsDefaultTraits<GR>".
    2.10 +  ///In most cases, this parameter should not be set directly,
    2.11 +  ///consider to use the named template parameters instead.
    2.12  #ifdef DOXYGEN
    2.13    template <typename GR,
    2.14              typename TR>
    2.15 @@ -957,6 +962,9 @@
    2.16    ///
    2.17    /// This class should only be used through the \ref bfs() function,
    2.18    /// which makes it easier to use the algorithm.
    2.19 +  ///
    2.20 +  /// \tparam TR The traits class that defines various types used by the
    2.21 +  /// algorithm.
    2.22    template<class TR>
    2.23    class BfsWizard : public TR
    2.24    {
    2.25 @@ -1295,11 +1303,11 @@
    2.26    /// \ref BfsVisitor "BfsVisitor<GR>" is an empty visitor, which
    2.27    /// does not observe the BFS events. If you want to observe the BFS
    2.28    /// events, you should implement your own visitor class.
    2.29 -  /// \tparam TR Traits class to set various data types used by the
    2.30 -  /// algorithm. The default traits class is
    2.31 -  /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<GR>".
    2.32 -  /// See \ref BfsVisitDefaultTraits for the documentation of
    2.33 -  /// a BFS visit traits class.
    2.34 +  /// \tparam TR The traits class that defines various types used by the
    2.35 +  /// algorithm. By default, it is \ref BfsVisitDefaultTraits
    2.36 +  /// "BfsVisitDefaultTraits<GR>".
    2.37 +  /// In most cases, this parameter should not be set directly,
    2.38 +  /// consider to use the named template parameters instead.
    2.39  #ifdef DOXYGEN
    2.40    template <typename GR, typename VS, typename TR>
    2.41  #else
     3.1 --- a/lemon/capacity_scaling.h	Thu Feb 11 16:55:54 2010 +0000
     3.2 +++ b/lemon/capacity_scaling.h	Fri Feb 12 21:53:15 2010 +0100
     3.3 @@ -77,9 +77,14 @@
     3.4    ///
     3.5    /// \tparam GR The digraph type the algorithm runs on.
     3.6    /// \tparam V The number type used for flow amounts, capacity bounds
     3.7 -  /// and supply values in the algorithm. By default it is \c int.
     3.8 +  /// and supply values in the algorithm. By default, it is \c int.
     3.9    /// \tparam C The number type used for costs and potentials in the
    3.10 -  /// algorithm. By default it is the same as \c V.
    3.11 +  /// algorithm. By default, it is the same as \c V.
    3.12 +  /// \tparam TR The traits class that defines various types used by the
    3.13 +  /// algorithm. By default, it is \ref CapacityScalingDefaultTraits
    3.14 +  /// "CapacityScalingDefaultTraits<GR, V, C>".
    3.15 +  /// In most cases, this parameter should not be set directly,
    3.16 +  /// consider to use the named template parameters instead.
    3.17    ///
    3.18    /// \warning Both number types must be signed and all input data must
    3.19    /// be integer.
     4.1 --- a/lemon/circulation.h	Thu Feb 11 16:55:54 2010 +0000
     4.2 +++ b/lemon/circulation.h	Fri Feb 12 21:53:15 2010 +0100
     4.3 @@ -173,6 +173,11 @@
     4.4       The default map type is \c LM.
     4.5       \tparam SM The type of the supply map. The default map type is
     4.6       \ref concepts::Digraph::NodeMap "GR::NodeMap<UM::Value>".
     4.7 +     \tparam TR The traits class that defines various types used by the
     4.8 +     algorithm. By default, it is \ref CirculationDefaultTraits
     4.9 +     "CirculationDefaultTraits<GR, LM, UM, SM>".
    4.10 +     In most cases, this parameter should not be set directly,
    4.11 +     consider to use the named template parameters instead.
    4.12    */
    4.13  #ifdef DOXYGEN
    4.14  template< typename GR,
     5.1 --- a/lemon/cost_scaling.h	Thu Feb 11 16:55:54 2010 +0000
     5.2 +++ b/lemon/cost_scaling.h	Fri Feb 12 21:53:15 2010 +0100
     5.3 @@ -104,9 +104,14 @@
     5.4    ///
     5.5    /// \tparam GR The digraph type the algorithm runs on.
     5.6    /// \tparam V The number type used for flow amounts, capacity bounds
     5.7 -  /// and supply values in the algorithm. By default it is \c int.
     5.8 +  /// and supply values in the algorithm. By default, it is \c int.
     5.9    /// \tparam C The number type used for costs and potentials in the
    5.10 -  /// algorithm. By default it is the same as \c V.
    5.11 +  /// algorithm. By default, it is the same as \c V.
    5.12 +  /// \tparam TR The traits class that defines various types used by the
    5.13 +  /// algorithm. By default, it is \ref CostScalingDefaultTraits
    5.14 +  /// "CostScalingDefaultTraits<GR, V, C>".
    5.15 +  /// In most cases, this parameter should not be set directly,
    5.16 +  /// consider to use the named template parameters instead.
    5.17    ///
    5.18    /// \warning Both number types must be signed and all input data must
    5.19    /// be integer.
    5.20 @@ -136,8 +141,7 @@
    5.21      /// \brief The large cost type
    5.22      ///
    5.23      /// The large cost type used for internal computations.
    5.24 -    /// Using the \ref CostScalingDefaultTraits "default traits class",
    5.25 -    /// it is \c long \c long if the \c Cost type is integer,
    5.26 +    /// By default, it is \c long \c long if the \c Cost type is integer,
    5.27      /// otherwise it is \c double.
    5.28      typedef typename TR::LargeCost LargeCost;
    5.29  
     6.1 --- a/lemon/dfs.h	Thu Feb 11 16:55:54 2010 +0000
     6.2 +++ b/lemon/dfs.h	Fri Feb 12 21:53:15 2010 +0100
     6.3 @@ -121,6 +121,11 @@
     6.4    ///
     6.5    ///\tparam GR The type of the digraph the algorithm runs on.
     6.6    ///The default type is \ref ListDigraph.
     6.7 +  ///\tparam TR The traits class that defines various types used by the
     6.8 +  ///algorithm. By default, it is \ref DfsDefaultTraits
     6.9 +  ///"DfsDefaultTraits<GR>".
    6.10 +  ///In most cases, this parameter should not be set directly,
    6.11 +  ///consider to use the named template parameters instead.
    6.12  #ifdef DOXYGEN
    6.13    template <typename GR,
    6.14              typename TR>
    6.15 @@ -887,6 +892,9 @@
    6.16    ///
    6.17    /// This class should only be used through the \ref dfs() function,
    6.18    /// which makes it easier to use the algorithm.
    6.19 +  ///
    6.20 +  /// \tparam TR The traits class that defines various types used by the
    6.21 +  /// algorithm.
    6.22    template<class TR>
    6.23    class DfsWizard : public TR
    6.24    {
    6.25 @@ -1237,11 +1245,11 @@
    6.26    /// \ref DfsVisitor "DfsVisitor<GR>" is an empty visitor, which
    6.27    /// does not observe the DFS events. If you want to observe the DFS
    6.28    /// events, you should implement your own visitor class.
    6.29 -  /// \tparam TR Traits class to set various data types used by the
    6.30 -  /// algorithm. The default traits class is
    6.31 -  /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<GR>".
    6.32 -  /// See \ref DfsVisitDefaultTraits for the documentation of
    6.33 -  /// a DFS visit traits class.
    6.34 +  /// \tparam TR The traits class that defines various types used by the
    6.35 +  /// algorithm. By default, it is \ref DfsVisitDefaultTraits
    6.36 +  /// "DfsVisitDefaultTraits<GR>".
    6.37 +  /// In most cases, this parameter should not be set directly,
    6.38 +  /// consider to use the named template parameters instead.
    6.39  #ifdef DOXYGEN
    6.40    template <typename GR, typename VS, typename TR>
    6.41  #else
     7.1 --- a/lemon/dijkstra.h	Thu Feb 11 16:55:54 2010 +0000
     7.2 +++ b/lemon/dijkstra.h	Fri Feb 12 21:53:15 2010 +0100
     7.3 @@ -192,6 +192,11 @@
     7.4    ///relatively time consuming process to compute the arc lengths if
     7.5    ///it is necessary. The default map type is \ref
     7.6    ///concepts::Digraph::ArcMap "GR::ArcMap<int>".
     7.7 +  ///\tparam TR The traits class that defines various types used by the
     7.8 +  ///algorithm. By default, it is \ref DijkstraDefaultTraits
     7.9 +  ///"DijkstraDefaultTraits<GR, LEN>".
    7.10 +  ///In most cases, this parameter should not be set directly,
    7.11 +  ///consider to use the named template parameters instead.
    7.12  #ifdef DOXYGEN
    7.13    template <typename GR, typename LEN, typename TR>
    7.14  #else
    7.15 @@ -1092,6 +1097,9 @@
    7.16    ///
    7.17    /// This class should only be used through the \ref dijkstra() function,
    7.18    /// which makes it easier to use the algorithm.
    7.19 +  ///
    7.20 +  /// \tparam TR The traits class that defines various types used by the
    7.21 +  /// algorithm.
    7.22    template<class TR>
    7.23    class DijkstraWizard : public TR
    7.24    {
     8.1 --- a/lemon/hartmann_orlin.h	Thu Feb 11 16:55:54 2010 +0000
     8.2 +++ b/lemon/hartmann_orlin.h	Fri Feb 12 21:53:15 2010 +0100
     8.3 @@ -106,6 +106,11 @@
     8.4    /// \tparam GR The type of the digraph the algorithm runs on.
     8.5    /// \tparam LEN The type of the length map. The default
     8.6    /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
     8.7 +  /// \tparam TR The traits class that defines various types used by the
     8.8 +  /// algorithm. By default, it is \ref HartmannOrlinDefaultTraits
     8.9 +  /// "HartmannOrlinDefaultTraits<GR, LEN>".
    8.10 +  /// In most cases, this parameter should not be set directly,
    8.11 +  /// consider to use the named template parameters instead.
    8.12  #ifdef DOXYGEN
    8.13    template <typename GR, typename LEN, typename TR>
    8.14  #else
    8.15 @@ -127,8 +132,7 @@
    8.16      /// \brief The large value type
    8.17      ///
    8.18      /// The large value type used for internal computations.
    8.19 -    /// Using the \ref HartmannOrlinDefaultTraits "default traits class",
    8.20 -    /// it is \c long \c long if the \c Value type is integer,
    8.21 +    /// By default, it is \c long \c long if the \c Value type is integer,
    8.22      /// otherwise it is \c double.
    8.23      typedef typename TR::LargeValue LargeValue;
    8.24  
     9.1 --- a/lemon/howard.h	Thu Feb 11 16:55:54 2010 +0000
     9.2 +++ b/lemon/howard.h	Fri Feb 12 21:53:15 2010 +0100
     9.3 @@ -106,6 +106,11 @@
     9.4    /// \tparam GR The type of the digraph the algorithm runs on.
     9.5    /// \tparam LEN The type of the length map. The default
     9.6    /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
     9.7 +  /// \tparam TR The traits class that defines various types used by the
     9.8 +  /// algorithm. By default, it is \ref HowardDefaultTraits
     9.9 +  /// "HowardDefaultTraits<GR, LEN>".
    9.10 +  /// In most cases, this parameter should not be set directly,
    9.11 +  /// consider to use the named template parameters instead.
    9.12  #ifdef DOXYGEN
    9.13    template <typename GR, typename LEN, typename TR>
    9.14  #else
    9.15 @@ -127,8 +132,7 @@
    9.16      /// \brief The large value type
    9.17      ///
    9.18      /// The large value type used for internal computations.
    9.19 -    /// Using the \ref HowardDefaultTraits "default traits class",
    9.20 -    /// it is \c long \c long if the \c Value type is integer,
    9.21 +    /// By default, it is \c long \c long if the \c Value type is integer,
    9.22      /// otherwise it is \c double.
    9.23      typedef typename TR::LargeValue LargeValue;
    9.24  
    10.1 --- a/lemon/karp.h	Thu Feb 11 16:55:54 2010 +0000
    10.2 +++ b/lemon/karp.h	Fri Feb 12 21:53:15 2010 +0100
    10.3 @@ -104,6 +104,11 @@
    10.4    /// \tparam GR The type of the digraph the algorithm runs on.
    10.5    /// \tparam LEN The type of the length map. The default
    10.6    /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    10.7 +  /// \tparam TR The traits class that defines various types used by the
    10.8 +  /// algorithm. By default, it is \ref KarpDefaultTraits
    10.9 +  /// "KarpDefaultTraits<GR, LEN>".
   10.10 +  /// In most cases, this parameter should not be set directly,
   10.11 +  /// consider to use the named template parameters instead.
   10.12  #ifdef DOXYGEN
   10.13    template <typename GR, typename LEN, typename TR>
   10.14  #else
   10.15 @@ -125,8 +130,7 @@
   10.16      /// \brief The large value type
   10.17      ///
   10.18      /// The large value type used for internal computations.
   10.19 -    /// Using the \ref KarpDefaultTraits "default traits class",
   10.20 -    /// it is \c long \c long if the \c Value type is integer,
   10.21 +    /// By default, it is \c long \c long if the \c Value type is integer,
   10.22      /// otherwise it is \c double.
   10.23      typedef typename TR::LargeValue LargeValue;
   10.24  
    11.1 --- a/lemon/min_cost_arborescence.h	Thu Feb 11 16:55:54 2010 +0000
    11.2 +++ b/lemon/min_cost_arborescence.h	Fri Feb 12 21:53:15 2010 +0100
    11.3 @@ -112,17 +112,18 @@
    11.4    /// relatively time consuming process to compute the arc costs if
    11.5    /// it is necessary. The default map type is \ref
    11.6    /// concepts::Digraph::ArcMap "Digraph::ArcMap<int>".
    11.7 -  /// \param TR Traits class to set various data types used
    11.8 -  /// by the algorithm. The default traits class is
    11.9 -  /// \ref MinCostArborescenceDefaultTraits
   11.10 +  /// \tparam TR The traits class that defines various types used by the
   11.11 +  /// algorithm. By default, it is \ref MinCostArborescenceDefaultTraits
   11.12    /// "MinCostArborescenceDefaultTraits<GR, CM>".
   11.13 +  /// In most cases, this parameter should not be set directly,
   11.14 +  /// consider to use the named template parameters instead.
   11.15  #ifndef DOXYGEN
   11.16    template <typename GR,
   11.17              typename CM = typename GR::template ArcMap<int>,
   11.18              typename TR =
   11.19                MinCostArborescenceDefaultTraits<GR, CM> >
   11.20  #else
   11.21 -  template <typename GR, typename CM, typedef TR>
   11.22 +  template <typename GR, typename CM, typename TR>
   11.23  #endif
   11.24    class MinCostArborescence {
   11.25    public:
    12.1 --- a/lemon/preflow.h	Thu Feb 11 16:55:54 2010 +0000
    12.2 +++ b/lemon/preflow.h	Fri Feb 12 21:53:15 2010 +0100
    12.3 @@ -119,6 +119,11 @@
    12.4    /// \tparam GR The type of the digraph the algorithm runs on.
    12.5    /// \tparam CAP The type of the capacity map. The default map
    12.6    /// type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    12.7 +  /// \tparam TR The traits class that defines various types used by the
    12.8 +  /// algorithm. By default, it is \ref PreflowDefaultTraits
    12.9 +  /// "PreflowDefaultTraits<GR, CAP>".
   12.10 +  /// In most cases, this parameter should not be set directly,
   12.11 +  /// consider to use the named template parameters instead.
   12.12  #ifdef DOXYGEN
   12.13    template <typename GR, typename CAP, typename TR>
   12.14  #else