COIN-OR::LEMON - Graph Library

Changes in / [826:02109e17027f:824:974c48bda29e] in lemon-main


Ignore:
Location:
lemon
Files:
12 edited

Legend:

Unmodified
Added
Removed
  • lemon/bellman_ford.h

    r825 r804  
    172172  /// the lengths of the arcs. The default map type is
    173173  /// \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    174   /// \tparam TR The traits class that defines various types used by the
    175   /// algorithm. By default, it is \ref BellmanFordDefaultTraits
    176   /// "BellmanFordDefaultTraits<GR, LEN>".
    177   /// In most cases, this parameter should not be set directly,
    178   /// consider to use the named template parameters instead.
    179174#ifdef DOXYGEN
    180175  template <typename GR, typename LEN, typename TR>
     
    939934  /// This class should only be used through the \ref bellmanFord()
    940935  /// function, which makes it easier to use the algorithm.
    941   ///
    942   /// \tparam TR The traits class that defines various types used by the
    943   /// algorithm.
    944936  template<class TR>
    945937  class BellmanFordWizard : public TR {
  • lemon/bfs.h

    r825 r788  
    122122  ///\tparam GR The type of the digraph the algorithm runs on.
    123123  ///The default type is \ref ListDigraph.
    124   ///\tparam TR The traits class that defines various types used by the
    125   ///algorithm. By default, it is \ref BfsDefaultTraits
    126   ///"BfsDefaultTraits<GR>".
    127   ///In most cases, this parameter should not be set directly,
    128   ///consider to use the named template parameters instead.
    129124#ifdef DOXYGEN
    130125  template <typename GR,
     
    963958  /// This class should only be used through the \ref bfs() function,
    964959  /// which makes it easier to use the algorithm.
    965   ///
    966   /// \tparam TR The traits class that defines various types used by the
    967   /// algorithm.
    968960  template<class TR>
    969961  class BfsWizard : public TR
     
    13041296  /// does not observe the BFS events. If you want to observe the BFS
    13051297  /// events, you should implement your own visitor class.
    1306   /// \tparam TR The traits class that defines various types used by the
    1307   /// algorithm. By default, it is \ref BfsVisitDefaultTraits
    1308   /// "BfsVisitDefaultTraits<GR>".
    1309   /// In most cases, this parameter should not be set directly,
    1310   /// consider to use the named template parameters instead.
     1298  /// \tparam TR Traits class to set various data types used by the
     1299  /// algorithm. The default traits class is
     1300  /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<GR>".
     1301  /// See \ref BfsVisitDefaultTraits for the documentation of
     1302  /// a BFS visit traits class.
    13111303#ifdef DOXYGEN
    13121304  template <typename GR, typename VS, typename TR>
  • lemon/capacity_scaling.h

    r825 r821  
    7878  /// \tparam GR The digraph type the algorithm runs on.
    7979  /// \tparam V The number type used for flow amounts, capacity bounds
    80   /// and supply values in the algorithm. By default, it is \c int.
     80  /// and supply values in the algorithm. By default it is \c int.
    8181  /// \tparam C The number type used for costs and potentials in the
    82   /// algorithm. By default, it is the same as \c V.
    83   /// \tparam TR The traits class that defines various types used by the
    84   /// algorithm. By default, it is \ref CapacityScalingDefaultTraits
    85   /// "CapacityScalingDefaultTraits<GR, V, C>".
    86   /// In most cases, this parameter should not be set directly,
    87   /// consider to use the named template parameters instead.
     82  /// algorithm. By default it is the same as \c V.
    8883  ///
    8984  /// \warning Both number types must be signed and all input data must
  • lemon/circulation.h

    r825 r786  
    174174     \tparam SM The type of the supply map. The default map type is
    175175     \ref concepts::Digraph::NodeMap "GR::NodeMap<UM::Value>".
    176      \tparam TR The traits class that defines various types used by the
    177      algorithm. By default, it is \ref CirculationDefaultTraits
    178      "CirculationDefaultTraits<GR, LM, UM, SM>".
    179      In most cases, this parameter should not be set directly,
    180      consider to use the named template parameters instead.
    181176  */
    182177#ifdef DOXYGEN
  • lemon/cost_scaling.h

    r825 r821  
    105105  /// \tparam GR The digraph type the algorithm runs on.
    106106  /// \tparam V The number type used for flow amounts, capacity bounds
    107   /// and supply values in the algorithm. By default, it is \c int.
     107  /// and supply values in the algorithm. By default it is \c int.
    108108  /// \tparam C The number type used for costs and potentials in the
    109   /// algorithm. By default, it is the same as \c V.
    110   /// \tparam TR The traits class that defines various types used by the
    111   /// algorithm. By default, it is \ref CostScalingDefaultTraits
    112   /// "CostScalingDefaultTraits<GR, V, C>".
    113   /// In most cases, this parameter should not be set directly,
    114   /// consider to use the named template parameters instead.
     109  /// algorithm. By default it is the same as \c V.
    115110  ///
    116111  /// \warning Both number types must be signed and all input data must
     
    142137    ///
    143138    /// The large cost type used for internal computations.
    144     /// By default, it is \c long \c long if the \c Cost type is integer,
     139    /// Using the \ref CostScalingDefaultTraits "default traits class",
     140    /// it is \c long \c long if the \c Cost type is integer,
    145141    /// otherwise it is \c double.
    146142    typedef typename TR::LargeCost LargeCost;
  • lemon/dfs.h

    r825 r788  
    122122  ///\tparam GR The type of the digraph the algorithm runs on.
    123123  ///The default type is \ref ListDigraph.
    124   ///\tparam TR The traits class that defines various types used by the
    125   ///algorithm. By default, it is \ref DfsDefaultTraits
    126   ///"DfsDefaultTraits<GR>".
    127   ///In most cases, this parameter should not be set directly,
    128   ///consider to use the named template parameters instead.
    129124#ifdef DOXYGEN
    130125  template <typename GR,
     
    893888  /// This class should only be used through the \ref dfs() function,
    894889  /// which makes it easier to use the algorithm.
    895   ///
    896   /// \tparam TR The traits class that defines various types used by the
    897   /// algorithm.
    898890  template<class TR>
    899891  class DfsWizard : public TR
     
    12461238  /// does not observe the DFS events. If you want to observe the DFS
    12471239  /// events, you should implement your own visitor class.
    1248   /// \tparam TR The traits class that defines various types used by the
    1249   /// algorithm. By default, it is \ref DfsVisitDefaultTraits
    1250   /// "DfsVisitDefaultTraits<GR>".
    1251   /// In most cases, this parameter should not be set directly,
    1252   /// consider to use the named template parameters instead.
     1240  /// \tparam TR Traits class to set various data types used by the
     1241  /// algorithm. The default traits class is
     1242  /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<GR>".
     1243  /// See \ref DfsVisitDefaultTraits for the documentation of
     1244  /// a DFS visit traits class.
    12531245#ifdef DOXYGEN
    12541246  template <typename GR, typename VS, typename TR>
  • lemon/dijkstra.h

    r825 r788  
    193193  ///it is necessary. The default map type is \ref
    194194  ///concepts::Digraph::ArcMap "GR::ArcMap<int>".
    195   ///\tparam TR The traits class that defines various types used by the
    196   ///algorithm. By default, it is \ref DijkstraDefaultTraits
    197   ///"DijkstraDefaultTraits<GR, LEN>".
    198   ///In most cases, this parameter should not be set directly,
    199   ///consider to use the named template parameters instead.
    200195#ifdef DOXYGEN
    201196  template <typename GR, typename LEN, typename TR>
     
    10981093  /// This class should only be used through the \ref dijkstra() function,
    10991094  /// which makes it easier to use the algorithm.
    1100   ///
    1101   /// \tparam TR The traits class that defines various types used by the
    1102   /// algorithm.
    11031095  template<class TR>
    11041096  class DijkstraWizard : public TR
  • lemon/hartmann_orlin.h

    r825 r795  
    107107  /// \tparam LEN The type of the length map. The default
    108108  /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    109   /// \tparam TR The traits class that defines various types used by the
    110   /// algorithm. By default, it is \ref HartmannOrlinDefaultTraits
    111   /// "HartmannOrlinDefaultTraits<GR, LEN>".
    112   /// In most cases, this parameter should not be set directly,
    113   /// consider to use the named template parameters instead.
    114109#ifdef DOXYGEN
    115110  template <typename GR, typename LEN, typename TR>
     
    133128    ///
    134129    /// The large value type used for internal computations.
    135     /// By default, it is \c long \c long if the \c Value type is integer,
     130    /// Using the \ref HartmannOrlinDefaultTraits "default traits class",
     131    /// it is \c long \c long if the \c Value type is integer,
    136132    /// otherwise it is \c double.
    137133    typedef typename TR::LargeValue LargeValue;
  • lemon/howard.h

    r825 r771  
    107107  /// \tparam LEN The type of the length map. The default
    108108  /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    109   /// \tparam TR The traits class that defines various types used by the
    110   /// algorithm. By default, it is \ref HowardDefaultTraits
    111   /// "HowardDefaultTraits<GR, LEN>".
    112   /// In most cases, this parameter should not be set directly,
    113   /// consider to use the named template parameters instead.
    114109#ifdef DOXYGEN
    115110  template <typename GR, typename LEN, typename TR>
     
    133128    ///
    134129    /// The large value type used for internal computations.
    135     /// By default, it is \c long \c long if the \c Value type is integer,
     130    /// Using the \ref HowardDefaultTraits "default traits class",
     131    /// it is \c long \c long if the \c Value type is integer,
    136132    /// otherwise it is \c double.
    137133    typedef typename TR::LargeValue LargeValue;
  • lemon/karp.h

    r825 r772  
    105105  /// \tparam LEN The type of the length map. The default
    106106  /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    107   /// \tparam TR The traits class that defines various types used by the
    108   /// algorithm. By default, it is \ref KarpDefaultTraits
    109   /// "KarpDefaultTraits<GR, LEN>".
    110   /// In most cases, this parameter should not be set directly,
    111   /// consider to use the named template parameters instead.
    112107#ifdef DOXYGEN
    113108  template <typename GR, typename LEN, typename TR>
     
    131126    ///
    132127    /// The large value type used for internal computations.
    133     /// By default, it is \c long \c long if the \c Value type is integer,
     128    /// Using the \ref KarpDefaultTraits "default traits class",
     129    /// it is \c long \c long if the \c Value type is integer,
    134130    /// otherwise it is \c double.
    135131    typedef typename TR::LargeValue LargeValue;
  • lemon/min_cost_arborescence.h

    r825 r713  
    113113  /// it is necessary. The default map type is \ref
    114114  /// concepts::Digraph::ArcMap "Digraph::ArcMap<int>".
    115   /// \tparam TR The traits class that defines various types used by the
    116   /// algorithm. By default, it is \ref MinCostArborescenceDefaultTraits
     115  /// \param TR Traits class to set various data types used
     116  /// by the algorithm. The default traits class is
     117  /// \ref MinCostArborescenceDefaultTraits
    117118  /// "MinCostArborescenceDefaultTraits<GR, CM>".
    118   /// In most cases, this parameter should not be set directly,
    119   /// consider to use the named template parameters instead.
    120119#ifndef DOXYGEN
    121120  template <typename GR,
     
    124123              MinCostArborescenceDefaultTraits<GR, CM> >
    125124#else
    126   template <typename GR, typename CM, typename TR>
     125  template <typename GR, typename CM, typedef TR>
    127126#endif
    128127  class MinCostArborescence {
  • lemon/preflow.h

    r825 r823  
    120120  /// \tparam CAP The type of the capacity map. The default map
    121121  /// type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    122   /// \tparam TR The traits class that defines various types used by the
    123   /// algorithm. By default, it is \ref PreflowDefaultTraits
    124   /// "PreflowDefaultTraits<GR, CAP>".
    125   /// In most cases, this parameter should not be set directly,
    126   /// consider to use the named template parameters instead.
    127122#ifdef DOXYGEN
    128123  template <typename GR, typename CAP, typename TR>
Note: See TracChangeset for help on using the changeset viewer.