[Lemon-commits] Alpar Juttner: Merge
Lemon HG
hg at lemon.cs.elte.hu
Fri Feb 12 22:27:44 CET 2010
details: http://lemon.cs.elte.hu/hg/lemon/rev/7762cab7f372
changeset: 897:7762cab7f372
user: Alpar Juttner <alpar [at] cs.elte.hu>
date: Fri Feb 12 22:17:20 2010 +0100
description:
Merge
diffstat:
INSTALL | 22 ++++++++++++++++++++++
lemon/bellman_ford.h | 8 ++++++++
lemon/bfs.h | 18 +++++++++++++-----
lemon/capacity_scaling.h | 9 +++++++--
lemon/circulation.h | 5 +++++
lemon/cost_scaling.h | 12 ++++++++----
lemon/dfs.h | 18 +++++++++++++-----
lemon/dijkstra.h | 8 ++++++++
lemon/hartmann_orlin.h | 8 ++++++--
lemon/howard.h | 8 ++++++--
lemon/karp.h | 8 ++++++--
lemon/min_cost_arborescence.h | 9 +++++----
lemon/preflow.h | 5 +++++
13 files changed, 112 insertions(+), 26 deletions(-)
diffs (truncated from 344 to 300 lines):
diff --git a/INSTALL b/INSTALL
--- a/INSTALL
+++ b/INSTALL
@@ -173,3 +173,25 @@
--without-coin
Disable COIN-OR support.
+
+
+Makefile Variables
+==================
+
+Some Makefile variables are reserved by the GNU Coding Standards for
+the use of the "user" - the person building the package. For instance,
+CXX and CXXFLAGS are such variables, and have the same meaning as
+explained in the previous section. These variables can be set on the
+command line when invoking `make' like this:
+`make [VARIABLE=VALUE]...'
+
+WARNINGCXXFLAGS is a non-standard Makefile variable introduced by us
+to hold several compiler flags related to warnings. Its default value
+can be overridden when invoking `make'. For example to disable all
+warning flags use `make WARNINGCXXFLAGS='.
+
+In order to turn off a single flag from the default set of warning
+flags, you can use the CXXFLAGS variable, since this is passed after
+WARNINGCXXFLAGS. For example to turn off `-Wold-style-cast' (which is
+used by default when g++ is detected) you can use
+`make CXXFLAGS="-g -O2 -Wno-old-style-cast"'.
diff --git a/lemon/bellman_ford.h b/lemon/bellman_ford.h
--- a/lemon/bellman_ford.h
+++ b/lemon/bellman_ford.h
@@ -171,6 +171,11 @@
/// \tparam LEN A \ref concepts::ReadMap "readable" arc map that specifies
/// the lengths of the arcs. The default map type is
/// \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref BellmanFordDefaultTraits
+ /// "BellmanFordDefaultTraits<GR, LEN>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR, typename LEN, typename TR>
#else
@@ -933,6 +938,9 @@
///
/// This class should only be used through the \ref bellmanFord()
/// function, which makes it easier to use the algorithm.
+ ///
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm.
template<class TR>
class BellmanFordWizard : public TR {
typedef TR Base;
diff --git a/lemon/bfs.h b/lemon/bfs.h
--- a/lemon/bfs.h
+++ b/lemon/bfs.h
@@ -121,6 +121,11 @@
///
///\tparam GR The type of the digraph the algorithm runs on.
///The default type is \ref ListDigraph.
+ ///\tparam TR The traits class that defines various types used by the
+ ///algorithm. By default, it is \ref BfsDefaultTraits
+ ///"BfsDefaultTraits<GR>".
+ ///In most cases, this parameter should not be set directly,
+ ///consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR,
typename TR>
@@ -957,6 +962,9 @@
///
/// This class should only be used through the \ref bfs() function,
/// which makes it easier to use the algorithm.
+ ///
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm.
template<class TR>
class BfsWizard : public TR
{
@@ -1295,11 +1303,11 @@
/// \ref BfsVisitor "BfsVisitor<GR>" is an empty visitor, which
/// does not observe the BFS events. If you want to observe the BFS
/// events, you should implement your own visitor class.
- /// \tparam TR Traits class to set various data types used by the
- /// algorithm. The default traits class is
- /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<GR>".
- /// See \ref BfsVisitDefaultTraits for the documentation of
- /// a BFS visit traits class.
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref BfsVisitDefaultTraits
+ /// "BfsVisitDefaultTraits<GR>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR, typename VS, typename TR>
#else
diff --git a/lemon/capacity_scaling.h b/lemon/capacity_scaling.h
--- a/lemon/capacity_scaling.h
+++ b/lemon/capacity_scaling.h
@@ -77,9 +77,14 @@
///
/// \tparam GR The digraph type the algorithm runs on.
/// \tparam V The number type used for flow amounts, capacity bounds
- /// and supply values in the algorithm. By default it is \c int.
+ /// and supply values in the algorithm. By default, it is \c int.
/// \tparam C The number type used for costs and potentials in the
- /// algorithm. By default it is the same as \c V.
+ /// algorithm. By default, it is the same as \c V.
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref CapacityScalingDefaultTraits
+ /// "CapacityScalingDefaultTraits<GR, V, C>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
///
/// \warning Both number types must be signed and all input data must
/// be integer.
diff --git a/lemon/circulation.h b/lemon/circulation.h
--- a/lemon/circulation.h
+++ b/lemon/circulation.h
@@ -173,6 +173,11 @@
The default map type is \c LM.
\tparam SM The type of the supply map. The default map type is
\ref concepts::Digraph::NodeMap "GR::NodeMap<UM::Value>".
+ \tparam TR The traits class that defines various types used by the
+ algorithm. By default, it is \ref CirculationDefaultTraits
+ "CirculationDefaultTraits<GR, LM, UM, SM>".
+ In most cases, this parameter should not be set directly,
+ consider to use the named template parameters instead.
*/
#ifdef DOXYGEN
template< typename GR,
diff --git a/lemon/cost_scaling.h b/lemon/cost_scaling.h
--- a/lemon/cost_scaling.h
+++ b/lemon/cost_scaling.h
@@ -104,9 +104,14 @@
///
/// \tparam GR The digraph type the algorithm runs on.
/// \tparam V The number type used for flow amounts, capacity bounds
- /// and supply values in the algorithm. By default it is \c int.
+ /// and supply values in the algorithm. By default, it is \c int.
/// \tparam C The number type used for costs and potentials in the
- /// algorithm. By default it is the same as \c V.
+ /// algorithm. By default, it is the same as \c V.
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref CostScalingDefaultTraits
+ /// "CostScalingDefaultTraits<GR, V, C>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
///
/// \warning Both number types must be signed and all input data must
/// be integer.
@@ -136,8 +141,7 @@
/// \brief The large cost type
///
/// The large cost type used for internal computations.
- /// Using the \ref CostScalingDefaultTraits "default traits class",
- /// it is \c long \c long if the \c Cost type is integer,
+ /// By default, it is \c long \c long if the \c Cost type is integer,
/// otherwise it is \c double.
typedef typename TR::LargeCost LargeCost;
diff --git a/lemon/dfs.h b/lemon/dfs.h
--- a/lemon/dfs.h
+++ b/lemon/dfs.h
@@ -121,6 +121,11 @@
///
///\tparam GR The type of the digraph the algorithm runs on.
///The default type is \ref ListDigraph.
+ ///\tparam TR The traits class that defines various types used by the
+ ///algorithm. By default, it is \ref DfsDefaultTraits
+ ///"DfsDefaultTraits<GR>".
+ ///In most cases, this parameter should not be set directly,
+ ///consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR,
typename TR>
@@ -887,6 +892,9 @@
///
/// This class should only be used through the \ref dfs() function,
/// which makes it easier to use the algorithm.
+ ///
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm.
template<class TR>
class DfsWizard : public TR
{
@@ -1237,11 +1245,11 @@
/// \ref DfsVisitor "DfsVisitor<GR>" is an empty visitor, which
/// does not observe the DFS events. If you want to observe the DFS
/// events, you should implement your own visitor class.
- /// \tparam TR Traits class to set various data types used by the
- /// algorithm. The default traits class is
- /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<GR>".
- /// See \ref DfsVisitDefaultTraits for the documentation of
- /// a DFS visit traits class.
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref DfsVisitDefaultTraits
+ /// "DfsVisitDefaultTraits<GR>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR, typename VS, typename TR>
#else
diff --git a/lemon/dijkstra.h b/lemon/dijkstra.h
--- a/lemon/dijkstra.h
+++ b/lemon/dijkstra.h
@@ -192,6 +192,11 @@
///relatively time consuming process to compute the arc lengths if
///it is necessary. The default map type is \ref
///concepts::Digraph::ArcMap "GR::ArcMap<int>".
+ ///\tparam TR The traits class that defines various types used by the
+ ///algorithm. By default, it is \ref DijkstraDefaultTraits
+ ///"DijkstraDefaultTraits<GR, LEN>".
+ ///In most cases, this parameter should not be set directly,
+ ///consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR, typename LEN, typename TR>
#else
@@ -1092,6 +1097,9 @@
///
/// This class should only be used through the \ref dijkstra() function,
/// which makes it easier to use the algorithm.
+ ///
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm.
template<class TR>
class DijkstraWizard : public TR
{
diff --git a/lemon/hartmann_orlin.h b/lemon/hartmann_orlin.h
--- a/lemon/hartmann_orlin.h
+++ b/lemon/hartmann_orlin.h
@@ -106,6 +106,11 @@
/// \tparam GR The type of the digraph the algorithm runs on.
/// \tparam LEN The type of the length map. The default
/// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref HartmannOrlinDefaultTraits
+ /// "HartmannOrlinDefaultTraits<GR, LEN>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR, typename LEN, typename TR>
#else
@@ -127,8 +132,7 @@
/// \brief The large value type
///
/// The large value type used for internal computations.
- /// Using the \ref HartmannOrlinDefaultTraits "default traits class",
- /// it is \c long \c long if the \c Value type is integer,
+ /// By default, it is \c long \c long if the \c Value type is integer,
/// otherwise it is \c double.
typedef typename TR::LargeValue LargeValue;
diff --git a/lemon/howard.h b/lemon/howard.h
--- a/lemon/howard.h
+++ b/lemon/howard.h
@@ -106,6 +106,11 @@
/// \tparam GR The type of the digraph the algorithm runs on.
/// \tparam LEN The type of the length map. The default
/// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref HowardDefaultTraits
+ /// "HowardDefaultTraits<GR, LEN>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR, typename LEN, typename TR>
#else
@@ -127,8 +132,7 @@
/// \brief The large value type
///
/// The large value type used for internal computations.
- /// Using the \ref HowardDefaultTraits "default traits class",
- /// it is \c long \c long if the \c Value type is integer,
+ /// By default, it is \c long \c long if the \c Value type is integer,
/// otherwise it is \c double.
typedef typename TR::LargeValue LargeValue;
diff --git a/lemon/karp.h b/lemon/karp.h
--- a/lemon/karp.h
+++ b/lemon/karp.h
@@ -104,6 +104,11 @@
/// \tparam GR The type of the digraph the algorithm runs on.
/// \tparam LEN The type of the length map. The default
/// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
+ /// \tparam TR The traits class that defines various types used by the
+ /// algorithm. By default, it is \ref KarpDefaultTraits
+ /// "KarpDefaultTraits<GR, LEN>".
+ /// In most cases, this parameter should not be set directly,
+ /// consider to use the named template parameters instead.
#ifdef DOXYGEN
template <typename GR, typename LEN, typename TR>
#else
@@ -125,8 +130,7 @@
/// \brief The large value type
///
/// The large value type used for internal computations.
- /// Using the \ref KarpDefaultTraits "default traits class",
- /// it is \c long \c long if the \c Value type is integer,
+ /// By default, it is \c long \c long if the \c Value type is integer,
More information about the Lemon-commits
mailing list