LEMON/LEMON-official Changeset - r525:9605e051942f

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r525:9605e051942f

« 463:88ed40

581:6d3a9e »

r525:9605e051942f

Mon, 23 Feb 2009 12:10:26

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Various doc improvements

0 8 0

default

8 files changed with 170 insertions and 171 deletions:

lemon/bfs.h

lemon/bits/array_map.h

lemon/bits/vector_map.h

lemon/circulation.h

lemon/concepts/graph_components.h

lemon/dfs.h

lemon/dijkstra.h

lemon/preflow.h

↑ Collapse diff ↑

lemon/bfs.h

Show inline comments

@@ -51,7 +51,7 @@
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 		    ///Instantiates a PredMap.
+		    ///Instantiates a \c PredMap.
 		    ///This function instantiates a PredMap.
+		    ///This function instantiates a \ref PredMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///PredMap.
+		    ///\ref PredMap.
 		    static PredMap *createPredMap(const Digraph &g)
@@ -66,7 +66,7 @@
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \c ProcessedMap.
 		    ///This function instantiates a ProcessedMap.
+		    ///This function instantiates a \ref ProcessedMap.
 		    ///\param g is the digraph, to which
 		    ///we would like to define the ProcessedMap
+		    ///we would like to define the \ref ProcessedMap
 		#ifdef DOXYGEN
@@ -85,7 +85,7 @@
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    ///Instantiates a ReachedMap.
+		    ///Instantiates a \c ReachedMap.
 		    ///This function instantiates a ReachedMap.
+		    ///This function instantiates a \ref ReachedMap.
 		    ///\param g is the digraph, to which
 		    ///we would like to define the ReachedMap.
+		    ///we would like to define the \ref ReachedMap.
 		    static ReachedMap *createReachedMap(const Digraph &g)
@@ -100,7 +100,7 @@
 		    typedef typename Digraph::template NodeMap<int> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \c DistMap.
 		    ///This function instantiates a DistMap.
+		    ///This function instantiates a \ref DistMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///DistMap.
+		    ///\ref DistMap.
 		    static DistMap *createDistMap(const Digraph &g)
@@ -223,6 +223,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///PredMap type.
+		    ///\c PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///PredMap type.
+		    ///\c PredMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -243,6 +243,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///DistMap type.
+		    ///\c DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///DistMap type.
+		    ///\c DistMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -263,6 +263,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ReachedMap type.
+		    ///\c ReachedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ReachedMap type.
+		    ///\c ReachedMap type.
 		    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
@@ -283,6 +283,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type.
+		    ///\c ProcessedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type.
+		    ///\c ProcessedMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -302,6 +302,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+		    ///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+		    ///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
@@ -1196,5 +1196,5 @@
 		  /// it could be the base of a real visitor class.
-		  template <typename _Digraph>
+		  template <typename GR>
 		  struct BfsVisitor {
-		    typedef _Digraph Digraph;
+		    typedef GR Digraph;
 		    typedef typename Digraph::Arc Arc;
@@ -1226,5 +1226,5 @@
 		#else
-		  template <typename _Digraph>
+		  template <typename GR>
 		  struct BfsVisitor {
-		    typedef _Digraph Digraph;
+		    typedef GR Digraph;
 		    typedef typename Digraph::Arc Arc;
@@ -1256,4 +1256,4 @@
 		  /// Default traits class of BfsVisit class.
 		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  template<class _Digraph>
 		  /// \tparam GR The type of the digraph the algorithm runs on.
 		  template<class GR>
 		  struct BfsVisitDefaultTraits {
@@ -1261,3 +1261,3 @@
 		    /// \brief The type of the digraph the algorithm runs on.
-		    typedef _Digraph Digraph;
+		    typedef GR Digraph;
@@ -1282,8 +1282,8 @@
 		  ///
-		  /// \brief %BFS algorithm class with visitor interface.
 		  /// \brief BFS algorithm class with visitor interface.
 		  ///
-		  /// This class provides an efficient implementation of the %BFS algorithm
 		  /// This class provides an efficient implementation of the BFS algorithm
 		  /// with visitor interface.
 		  ///
-		  /// The %BfsVisit class provides an alternative interface to the Bfs
 		  /// The BfsVisit class provides an alternative interface to the Bfs
 		  /// class. It works with callback mechanism, the BfsVisit object calls
@@ -1296,13 +1296,13 @@
 		  ///
 		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  /// The default value is
 		  /// \ref ListDigraph. The value of _Digraph is not used directly by
 		  /// \ref BfsVisit, it is only passed to \ref BfsVisitDefaultTraits.
 		  /// \tparam _Visitor The Visitor type that is used by the algorithm.
 		  /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty visitor, which
 		  /// \tparam GR The type of the digraph the algorithm runs on.
 		  /// The default type is \ref ListDigraph.
 		  /// The value of GR is not used directly by \ref BfsVisit,
 		  /// it is only passed to \ref BfsVisitDefaultTraits.
 		  /// \tparam VS The Visitor type that is used by the algorithm.
 		  /// \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 _Traits Traits class to set various data types used by the
+		  /// \tparam TR Traits class to set various data types used by the
 		  /// algorithm. The default traits class is
-		  /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<_Digraph>".
+		  /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<GR>".
 		  /// See \ref BfsVisitDefaultTraits for the documentation of
@@ -1310,7 +1310,7 @@
 		#ifdef DOXYGEN
-		  template <typename _Digraph, typename _Visitor, typename _Traits>
+		  template <typename GR, typename VS, typename TR>
 		#else
 		  template <typename _Digraph = ListDigraph,
 		            typename _Visitor = BfsVisitor<_Digraph>,
-		            typename _Traits = BfsVisitDefaultTraits<_Digraph> >
+		  template <typename GR = ListDigraph,
 		            typename VS = BfsVisitor<GR>,
 		            typename TR = BfsVisitDefaultTraits<GR> >
 		#endif
@@ -1320,3 +1320,3 @@
 		    ///The traits class.
-		    typedef _Traits Traits;
+		    typedef TR Traits;
@@ -1326,3 +1326,3 @@
 		    ///The visitor type used by the algorithm.
-		    typedef _Visitor Visitor;
+		    typedef VS Visitor;

lemon/bits/array_map.h

Show inline comments

@@ -137,3 +137,3 @@
 		    //
-		    // The given parameter should be conform to the ReadMap
 		    // The given parameter should conform to the ReadMap
 		    // concecpt and could be indiced by the current item set of

lemon/bits/vector_map.h

Show inline comments

@@ -126,3 +126,3 @@
 		    //
-		    // The given parameter should be conform to the ReadMap
 		    // The given parameter should conform to the ReadMap
 		    // concecpt and could be indiced by the current item set of

lemon/circulation.h

Show inline comments

@@ -33,8 +33,8 @@
 		  /// Default traits class of Circulation class.
 		  /// \tparam _Diraph Digraph type.
 		  /// \tparam _LCapMap Lower bound capacity map type.
 		  /// \tparam _UCapMap Upper bound capacity map type.
 		  /// \tparam _DeltaMap Delta map type.
 		  template <typename _Diraph, typename _LCapMap,
 		            typename _UCapMap, typename _DeltaMap>
 		  /// \tparam GR Digraph type.
 		  /// \tparam LM Lower bound capacity map type.
 		  /// \tparam UM Upper bound capacity map type.
 		  /// \tparam DM Delta map type.
 		  template <typename GR, typename LM,
 		            typename UM, typename DM>
 		  struct CirculationDefaultTraits {
@@ -42,3 +42,3 @@
 		    /// \brief The type of the digraph the algorithm runs on.
-		    typedef _Diraph Digraph;
+		    typedef GR Digraph;
@@ -49,3 +49,3 @@
 		    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
-		    typedef _LCapMap LCapMap;
+		    typedef LM LCapMap;
@@ -56,3 +56,3 @@
 		    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
-		    typedef _UCapMap UCapMap;
+		    typedef UM UCapMap;
@@ -64,3 +64,3 @@
 		    /// concept.
-		    typedef _DeltaMap DeltaMap;
+		    typedef DM DeltaMap;
@@ -139,25 +139,23 @@
 		     \tparam _Digraph The type of the digraph the algorithm runs on.
 		     \tparam _LCapMap The type of the lower bound capacity map. The default
 		     map type is \ref concepts::Digraph::ArcMap "_Digraph::ArcMap<int>".
 		     \tparam _UCapMap The type of the upper bound capacity map. The default
 		     map type is \c _LCapMap.
 		     \tparam _DeltaMap The type of the map that stores the lower bound
 		     \tparam GR The type of the digraph the algorithm runs on.
 		     \tparam LM The type of the lower bound capacity map. The default
 		     map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
 		     \tparam UM The type of the upper bound capacity map. The default
 		     map type is \c LM.
 		     \tparam DM The type of the map that stores the lower bound
 		     for the supply of the nodes. The default map type is
-		     \c _Digraph::ArcMap<_UCapMap::Value>.
+		     \ref concepts::Digraph::NodeMap "GR::NodeMap<UM::Value>".
 		  */
 		#ifdef DOXYGEN
 		template< typename _Digraph,
 		          typename _LCapMap,
 		          typename _UCapMap,
 		          typename _DeltaMap,
-		          typename _Traits >
+		template< typename GR,
 		          typename LM,
 		          typename UM,
 		          typename DM,
 		          typename TR >
 		#else
 		template< typename _Digraph,
 		          typename _LCapMap = typename _Digraph::template ArcMap<int>,
 		          typename _UCapMap = _LCapMap,
 		          typename _DeltaMap = typename _Digraph::
 		                               template NodeMap<typename _UCapMap::Value>,
 		          typename _Traits=CirculationDefaultTraits<_Digraph, _LCapMap,
-		                                                    _UCapMap, _DeltaMap> >
+		template< typename GR,
 		          typename LM = typename GR::template ArcMap<int>,
 		          typename UM = LM,
 		          typename DM = typename GR::template NodeMap<typename UM::Value>,
 		          typename TR = CirculationDefaultTraits<GR, LM, UM, DM> >
 		#endif
@@ -167,3 +165,3 @@
 		    ///The \ref CirculationDefaultTraits "traits class" of the algorithm.
-		    typedef _Traits Traits;
+		    typedef TR Traits;
 		    ///The type of the digraph the algorithm runs on.

lemon/concepts/graph_components.h

Show inline comments

@@ -116,3 +116,3 @@
 		    /// This class provides the minimal set of features needed for a
-		    /// directed graph structure. All digraph concepts have to be
 		    /// directed graph structure. All digraph concepts have to
 		    /// conform to this base directed graph. It just provides types
@@ -181,3 +181,3 @@
 		    /// undirected graph structure. All undirected graph concepts have
-		    /// to be conform to this base graph. It just provides types for
 		    /// to conform to this base graph. It just provides types for
 		    /// nodes, arcs and edges and functions to get the
@@ -296,3 +296,3 @@
 		    /// core id functions for the digraph structure.
-		    /// The most of the base digraphs should be conform to this concept.
 		    /// The most of the base digraphs should conform to this concept.
 		    /// The id's are unique and immutable.
@@ -374,3 +374,3 @@
 		    /// core id functions for the undirected graph structure.  The
-		    /// most of the base undirected graphs should be conform to this
 		    /// most of the base undirected graphs should conform to this
 		    /// concept.  The id's are unique and immutable.

lemon/dfs.h

Show inline comments

@@ -51,7 +51,7 @@
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 		    ///Instantiates a PredMap.
+		    ///Instantiates a \c PredMap.
 		    ///This function instantiates a PredMap.
+		    ///This function instantiates a \ref PredMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///PredMap.
+		    ///\ref PredMap.
 		    static PredMap *createPredMap(const Digraph &g)
@@ -66,7 +66,7 @@
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \c ProcessedMap.
 		    ///This function instantiates a ProcessedMap.
+		    ///This function instantiates a \ref ProcessedMap.
 		    ///\param g is the digraph, to which
 		    ///we would like to define the ProcessedMap
+		    ///we would like to define the \ref ProcessedMap.
 		#ifdef DOXYGEN
@@ -85,7 +85,7 @@
 		    typedef typename Digraph::template NodeMap<bool> ReachedMap;
 		    ///Instantiates a ReachedMap.
+		    ///Instantiates a \c ReachedMap.
 		    ///This function instantiates a ReachedMap.
+		    ///This function instantiates a \ref ReachedMap.
 		    ///\param g is the digraph, to which
 		    ///we would like to define the ReachedMap.
+		    ///we would like to define the \ref ReachedMap.
 		    static ReachedMap *createReachedMap(const Digraph &g)
@@ -100,7 +100,7 @@
 		    typedef typename Digraph::template NodeMap<int> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \c DistMap.
 		    ///This function instantiates a DistMap.
+		    ///This function instantiates a \ref DistMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///DistMap.
+		    ///\ref DistMap.
 		    static DistMap *createDistMap(const Digraph &g)
@@ -222,6 +222,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///PredMap type.
+		    ///\c PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///PredMap type.
+		    ///\c PredMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -242,6 +242,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///DistMap type.
+		    ///\c DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///DistMap type.
+		    ///\c DistMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -262,6 +262,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ReachedMap type.
+		    ///\c ReachedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ReachedMap type.
+		    ///\c ReachedMap type.
 		    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
@@ -282,6 +282,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type.
+		    ///\c ProcessedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type.
+		    ///\c ProcessedMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -300,6 +300,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+		    ///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+		    ///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
@@ -1128,5 +1128,5 @@
 		  /// it could be the base of a real visitor class.
-		  template <typename _Digraph>
+		  template <typename GR>
 		  struct DfsVisitor {
-		    typedef _Digraph Digraph;
+		    typedef GR Digraph;
 		    typedef typename Digraph::Arc Arc;
@@ -1166,5 +1166,5 @@
 		#else
-		  template <typename _Digraph>
+		  template <typename GR>
 		  struct DfsVisitor {
-		    typedef _Digraph Digraph;
+		    typedef GR Digraph;
 		    typedef typename Digraph::Arc Arc;
@@ -1201,3 +1201,3 @@
 		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
-		  template<class _Digraph>
+		  template<class GR>
 		  struct DfsVisitDefaultTraits {
@@ -1205,3 +1205,3 @@
 		    /// \brief The type of the digraph the algorithm runs on.
-		    typedef _Digraph Digraph;
+		    typedef GR Digraph;
@@ -1226,8 +1226,8 @@
 		  ///
-		  /// \brief %DFS algorithm class with visitor interface.
 		  /// \brief DFS algorithm class with visitor interface.
 		  ///
-		  /// This class provides an efficient implementation of the %DFS algorithm
 		  /// This class provides an efficient implementation of the DFS algorithm
 		  /// with visitor interface.
 		  ///
-		  /// The %DfsVisit class provides an alternative interface to the Dfs
 		  /// The DfsVisit class provides an alternative interface to the Dfs
 		  /// class. It works with callback mechanism, the DfsVisit object calls
@@ -1240,13 +1240,13 @@
 		  ///
 		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  /// The default value is
 		  /// \ref ListDigraph. The value of _Digraph is not used directly by
 		  /// \ref DfsVisit, it is only passed to \ref DfsVisitDefaultTraits.
 		  /// \tparam _Visitor The Visitor type that is used by the algorithm.
 		  /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty visitor, which
 		  /// \tparam GR The type of the digraph the algorithm runs on.
 		  /// The default type is \ref ListDigraph.
 		  /// The value of GR is not used directly by \ref DfsVisit,
 		  /// it is only passed to \ref DfsVisitDefaultTraits.
 		  /// \tparam VS The Visitor type that is used by the algorithm.
 		  /// \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 _Traits Traits class to set various data types used by the
+		  /// \tparam TR Traits class to set various data types used by the
 		  /// algorithm. The default traits class is
-		  /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<_Digraph>".
+		  /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<GR>".
 		  /// See \ref DfsVisitDefaultTraits for the documentation of
@@ -1254,7 +1254,7 @@
 		#ifdef DOXYGEN
-		  template <typename _Digraph, typename _Visitor, typename _Traits>
+		  template <typename GR, typename VS, typename TR>
 		#else
 		  template <typename _Digraph = ListDigraph,
 		            typename _Visitor = DfsVisitor<_Digraph>,
-		            typename _Traits = DfsVisitDefaultTraits<_Digraph> >
+		  template <typename GR = ListDigraph,
 		            typename VS = DfsVisitor<GR>,
 		            typename TR = DfsVisitDefaultTraits<GR> >
 		#endif
@@ -1264,3 +1264,3 @@
 		    ///The traits class.
-		    typedef _Traits Traits;
+		    typedef TR Traits;
@@ -1270,3 +1270,3 @@
 		    ///The visitor type used by the algorithm.
-		    typedef _Visitor Visitor;
+		    typedef VS Visitor;

lemon/dijkstra.h

Show inline comments

@@ -75,3 +75,3 @@
 		    /// Operation traits for Dijkstra algorithm.
+		    /// Operation traits for %Dijkstra algorithm.
@@ -86,3 +86,3 @@
 		    typedef typename Digraph::template NodeMap<int> HeapCrossRef;
-		    ///Instantiates a \ref HeapCrossRef.
+		    ///Instantiates a \c HeapCrossRef.
@@ -96,3 +96,3 @@
 		    ///The heap type used by the Dijkstra algorithm.
+		    ///The heap type used by the %Dijkstra algorithm.
@@ -103,3 +103,3 @@
 		    typedef BinHeap<typename LM::Value, HeapCrossRef, std::less<Value> > Heap;
-		    ///Instantiates a \ref Heap.
+		    ///Instantiates a \c Heap.
@@ -118,7 +118,7 @@
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 		    ///Instantiates a PredMap.
+		    ///Instantiates a \c PredMap.
 		    ///This function instantiates a PredMap.
+		    ///This function instantiates a \ref PredMap.
 		    ///\param g is the digraph, to which we would like to define the
 		    ///PredMap.
+		    ///\ref PredMap.
 		    static PredMap *createPredMap(const Digraph &g)
@@ -134,7 +134,7 @@
 		    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 		    ///Instantiates a ProcessedMap.
+		    ///Instantiates a \c ProcessedMap.
 		    ///This function instantiates a ProcessedMap.
+		    ///This function instantiates a \ref ProcessedMap.
 		    ///\param g is the digraph, to which
 		    ///we would like to define the ProcessedMap
+		    ///we would like to define the \ref ProcessedMap.
 		#ifdef DOXYGEN
@@ -153,7 +153,7 @@
 		    typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
 		    ///Instantiates a DistMap.
+		    ///Instantiates a \c DistMap.
 		    ///This function instantiates a DistMap.
+		    ///This function instantiates a \ref DistMap.
 		    ///\param g is the digraph, to which we would like to define
 		    ///the DistMap
+		    ///the \ref DistMap.
 		    static DistMap *createDistMap(const Digraph &g)
@@ -218,3 +218,4 @@
 		    typedef typename TR::Heap Heap;
-		    ///The operation traits class.
+		    ///\brief The \ref DijkstraDefaultOperationTraits "operation traits class"
 		    ///of the algorithm.
 		    typedef typename TR::OperationTraits OperationTraits;
@@ -234,3 +235,3 @@
 		    //Pointer to the length map.
-		    const LengthMap *length;
+		    const LengthMap *_length;
 		    //Pointer to the map of predecessors arcs.
@@ -299,6 +300,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///PredMap type.
+		    ///\c PredMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///PredMap type.
+		    ///\c PredMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -320,6 +321,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///DistMap type.
+		    ///\c DistMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///DistMap type.
+		    ///\c DistMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -341,6 +342,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type.
+		    ///\c ProcessedMap type.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type.
+		    ///\c ProcessedMap type.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
@@ -360,6 +361,6 @@
 		    ///\brief \ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+		    ///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+		    ///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
@@ -441,3 +442,3 @@
 		    ///\ref named-templ-param "Named parameter" for setting
-		    ///\ref OperationTraits type.
+		    ///\c OperationTraits type.
 		    template <class T>
@@ -460,6 +461,6 @@
 		    ///Constructor.
 		    ///\param _g The digraph the algorithm runs on.
 		    ///\param _length The length map used by the algorithm.
 		    Dijkstra(const Digraph& _g, const LengthMap& _length) :
 		      G(&_g), length(&_length),
 		    ///\param g The digraph the algorithm runs on.
 		    ///\param length The length map used by the algorithm.
 		    Dijkstra(const Digraph& g, const LengthMap& length) :
 		      G(&g), _length(&length),
 		      _pred(NULL), local_pred(false),
@@ -487,3 +488,3 @@
+		    {
-		      length = &m;
+		      _length = &m;
 		      return *this;
@@ -640,3 +641,3 @@
 		        case Heap::PRE_HEAP:
-		          _heap->push(w,OperationTraits::plus(oldvalue, (*length)[e]));
+		          _heap->push(w,OperationTraits::plus(oldvalue, (*_length)[e]));
 		          _pred->set(w,e);
@@ -645,3 +646,3 @@
+		          {
-		            Value newvalue = OperationTraits::plus(oldvalue, (*length)[e]);
+		            Value newvalue = OperationTraits::plus(oldvalue, (*_length)[e]);
 		            if ( OperationTraits::less(newvalue, (*_heap)[w]) ) {

lemon/preflow.h

Show inline comments

@@ -33,5 +33,5 @@
 		  /// Default traits class of Preflow class.
 		  /// \tparam _Digraph Digraph type.
 		  /// \tparam _CapacityMap Capacity map type.
-		  template <typename _Digraph, typename _CapacityMap>
+		  /// \tparam GR Digraph type.
 		  /// \tparam CM Capacity map type.
 		  template <typename GR, typename CM>
 		  struct PreflowDefaultTraits {
@@ -39,3 +39,3 @@
 		    /// \brief The type of the digraph the algorithm runs on.
-		    typedef _Digraph Digraph;
+		    typedef GR Digraph;
@@ -45,3 +45,3 @@
 		    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
-		    typedef _CapacityMap CapacityMap;
+		    typedef CM CapacityMap;
@@ -106,11 +106,11 @@
 		  ///
 		  /// \tparam _Digraph The type of the digraph the algorithm runs on.
 		  /// \tparam _CapacityMap The type of the capacity map. The default map
-		  /// type is \ref concepts::Digraph::ArcMap "_Digraph::ArcMap<int>".
+		  /// \tparam GR The type of the digraph the algorithm runs on.
 		  /// \tparam CM The type of the capacity map. The default map
 		  /// type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
 		#ifdef DOXYGEN
-		  template <typename _Digraph, typename _CapacityMap, typename _Traits>
+		  template <typename GR, typename CM, typename TR>
 		#else
 		  template <typename _Digraph,
 		            typename _CapacityMap = typename _Digraph::template ArcMap<int>,
-		            typename _Traits = PreflowDefaultTraits<_Digraph, _CapacityMap> >
+		  template <typename GR,
 		            typename CM = typename GR::template ArcMap<int>,
 		            typename TR = PreflowDefaultTraits<GR, CM> >
 		#endif
@@ -120,3 +120,3 @@
 		    ///The \ref PreflowDefaultTraits "traits class" of the algorithm.
-		    typedef _Traits Traits;
+		    typedef TR Traits;
 		    ///The type of the digraph the algorithm runs on.

0 comments (0 inline)

RhodeCode

Login to your account