Changeset - r825:75e6020b19b1
« 823:a7e93d
826:02109e »
gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Add doc for the traits class parameters (#315)
0 12 0
default
12 files changed with 90 insertions and 26 deletions:
lemon/bellman_ford.h
8
lemon/bfs.h
13
5
lemon/capacity_scaling.h
7
2
lemon/circulation.h
5
lemon/cost_scaling.h
8
4
lemon/dfs.h
13
5
lemon/dijkstra.h
8
lemon/hartmann_orlin.h
6
2
lemon/howard.h
6
2
lemon/karp.h
6
2
lemon/min_cost_arborescence.h
5
4
lemon/preflow.h
5
↑ Collapse diff ↑
lemon/bellman_ford.h
Ignore white space 6 line context
... ... 
@@ -173,2 +173,7 @@
173 173 
  /// \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.
174 179 
#ifdef DOXYGEN
... ... 
@@ -935,2 +940,5 @@
935 940 
  /// 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.
936 944 
  template<class TR>
lemon/bfs.h
Ignore white space 6 line context
... ... 
@@ -123,2 +123,7 @@
123 123 
  ///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.
124 129 
#ifdef DOXYGEN
... ... 
@@ -959,2 +964,5 @@
959 964 
  /// which makes it easier to use the algorithm.
965 
  ///
966 
  /// \tparam TR The traits class that defines various types used by the
967 
  /// algorithm.
960 968 
  template<class TR>
... ... 
@@ -1297,7 +1305,7 @@
1297 1305 
  /// events, you should implement your own visitor class.
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.
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.
1303 1311 
#ifdef DOXYGEN
lemon/capacity_scaling.h
Ignore white space 6 line context
... ... 
@@ -79,5 +79,10 @@
79 79 
  /// \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.
81 81 
  /// \tparam C The number type used for costs and potentials in the
82 
  /// algorithm. By default it is the same as \c V.
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.
83 88 
  ///
lemon/circulation.h
Ignore white space 6 line context
... ... 
@@ -175,2 +175,7 @@
175 175 
     \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.
176 181 
  */
lemon/cost_scaling.h
Ignore white space 6 line context
... ... 
@@ -106,5 +106,10 @@
106 106 
  /// \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.
108 108 
  /// \tparam C The number type used for costs and potentials in the
109 
  /// algorithm. By default it is the same as \c V.
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.
110 115 
  ///
... ... 
@@ -138,4 +143,3 @@
138 143 
    /// The large cost type used for internal computations.
139 
    /// Using the \ref CostScalingDefaultTraits "default traits class",
140 
    /// it is \c long \c long if the \c Cost type is integer,
144 
    /// By default, it is \c long \c long if the \c Cost type is integer,
141 145 
    /// otherwise it is \c double.
lemon/dfs.h
Ignore white space 6 line context
... ... 
@@ -123,2 +123,7 @@
123 123 
  ///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.
124 129 
#ifdef DOXYGEN
... ... 
@@ -889,2 +894,5 @@
889 894 
  /// which makes it easier to use the algorithm.
895 
  ///
896 
  /// \tparam TR The traits class that defines various types used by the
897 
  /// algorithm.
890 898 
  template<class TR>
... ... 
@@ -1239,7 +1247,7 @@
1239 1247 
  /// events, you should implement your own visitor class.
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.
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.
1245 1253 
#ifdef DOXYGEN
lemon/dijkstra.h
Show white space 6 line context
... ... 
@@ -194,2 +194,7 @@
194 194 
  ///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.
195 200 
#ifdef DOXYGEN
... ... 
@@ -1094,2 +1099,5 @@
1094 1099 
  /// which makes it easier to use the algorithm.
1100 
  ///
1101 
  /// \tparam TR The traits class that defines various types used by the
1102 
  /// algorithm.
1095 1103 
  template<class TR>
lemon/hartmann_orlin.h
Ignore white space 6 line context
... ... 
@@ -108,2 +108,7 @@
108 108 
  /// 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.
109 114 
#ifdef DOXYGEN
... ... 
@@ -129,4 +134,3 @@
129 134 
    /// The large value type used for internal computations.
130 
    /// Using the \ref HartmannOrlinDefaultTraits "default traits class",
131 
    /// it is \c long \c long if the \c Value type is integer,
135 
    /// By default, it is \c long \c long if the \c Value type is integer,
132 136 
    /// otherwise it is \c double.
lemon/howard.h
Ignore white space 6 line context
... ... 
@@ -108,2 +108,7 @@
108 108 
  /// 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.
109 114 
#ifdef DOXYGEN
... ... 
@@ -129,4 +134,3 @@
129 134 
    /// The large value type used for internal computations.
130 
    /// Using the \ref HowardDefaultTraits "default traits class",
131 
    /// it is \c long \c long if the \c Value type is integer,
135 
    /// By default, it is \c long \c long if the \c Value type is integer,
132 136 
    /// otherwise it is \c double.
lemon/karp.h
Ignore white space 6 line context
... ... 
@@ -106,2 +106,7 @@
106 106 
  /// 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.
107 112 
#ifdef DOXYGEN
... ... 
@@ -127,4 +132,3 @@
127 132 
    /// The large value type used for internal computations.
128 
    /// Using the \ref KarpDefaultTraits "default traits class",
129 
    /// it is \c long \c long if the \c Value type is integer,
133 
    /// By default, it is \c long \c long if the \c Value type is integer,
130 134 
    /// otherwise it is \c double.
lemon/min_cost_arborescence.h
Ignore white space 6 line context
... ... 
@@ -114,6 +114,7 @@
114 114 
  /// concepts::Digraph::ArcMap "Digraph::ArcMap<int>".
115 
  /// \param TR Traits class to set various data types used
116 
  /// by the algorithm. The default traits class is
117 
  /// \ref MinCostArborescenceDefaultTraits
115 
  /// \tparam TR The traits class that defines various types used by the
116 
  /// algorithm. By default, it is \ref MinCostArborescenceDefaultTraits
118 117 
  /// "MinCostArborescenceDefaultTraits<GR, CM>".
118 
  /// In most cases, this parameter should not be set directly,
119 
  /// consider to use the named template parameters instead.
119 120 
#ifndef DOXYGEN
... ... 
@@ -124,3 +125,3 @@
124 125 
#else
125 
  template <typename GR, typename CM, typedef TR>
126 
  template <typename GR, typename CM, typename TR>
126 127 
#endif
lemon/preflow.h
Ignore white space 6 line context
... ... 
@@ -121,2 +121,7 @@
121 121 
  /// 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.
122 127 
#ifdef DOXYGEN
0 comments (0 inline)