Changeset 606:c5fd2d996909 in lemon for lemon/euler.h

Timestamp:

03/29/09 23:08:20 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Various doc improvements (#248)

• Rename all the ugly template parameters (too long and/or starting with an underscore).
• Rename function parameters starting with an underscore.
• Extend the doc for many classes.
• Use LaTeX-style O(...) expressions only for the complicated ones.
• A lot of small unification changes.
• Small fixes.
• Some other improvements.

File:

• lemon/euler.h (modified) (5 diffs)

lemon/euler.h

@@ -55 +55 @@
   ///If \c g is not Euler then the resulted tour will not be full or closed.
   ///\sa EulerIt
-  template<class Digraph>
+  template<typename GR>
   class DiEulerIt
   {
-    typedef typename Digraph::Node Node;
-    typedef typename Digraph::NodeIt NodeIt;
-    typedef typename Digraph::Arc Arc;
-    typedef typename Digraph::ArcIt ArcIt;
-    typedef typename Digraph::OutArcIt OutArcIt;
-    typedef typename Digraph::InArcIt InArcIt;
-
-    const Digraph &g;
-    typename Digraph::template NodeMap<OutArcIt> nedge;
+    typedef typename GR::Node Node;
+    typedef typename GR::NodeIt NodeIt;
+    typedef typename GR::Arc Arc;
+    typedef typename GR::ArcIt ArcIt;
+    typedef typename GR::OutArcIt OutArcIt;
+    typedef typename GR::InArcIt InArcIt;
+
+    const GR &g;
+    typename GR::template NodeMap<OutArcIt> nedge;
     std::list<Arc> euler;
 
@@ -73 +73 @@
     ///Constructor
 
-    ///\param _g A digraph.
+    ///\param gr A digraph.
     ///\param start The starting point of the tour. If it is not given
     ///       the tour will start from the first node.
-    DiEulerIt(const Digraph &_g,typename Digraph::Node start=INVALID)
-      : g(_g), nedge(g)
+    DiEulerIt(const GR &gr, typename GR::Node start = INVALID)
+      : g(gr), nedge(g)
     {
       if(start==INVALID) start=NodeIt(g);
@@ -146 +146 @@
   ///If \c g is not Euler then the resulted tour will not be full or closed.
   ///\sa EulerIt
-  template<class Digraph>
+  template<typename GR>
   class EulerIt
   {
-    typedef typename Digraph::Node Node;
-    typedef typename Digraph::NodeIt NodeIt;
-    typedef typename Digraph::Arc Arc;
-    typedef typename Digraph::Edge Edge;
-    typedef typename Digraph::ArcIt ArcIt;
-    typedef typename Digraph::OutArcIt OutArcIt;
-    typedef typename Digraph::InArcIt InArcIt;
-
-    const Digraph &g;
-    typename Digraph::template NodeMap<OutArcIt> nedge;
-    typename Digraph::template EdgeMap<bool> visited;
+    typedef typename GR::Node Node;
+    typedef typename GR::NodeIt NodeIt;
+    typedef typename GR::Arc Arc;
+    typedef typename GR::Edge Edge;
+    typedef typename GR::ArcIt ArcIt;
+    typedef typename GR::OutArcIt OutArcIt;
+    typedef typename GR::InArcIt InArcIt;
+
+    const GR &g;
+    typename GR::template NodeMap<OutArcIt> nedge;
+    typename GR::template EdgeMap<bool> visited;
     std::list<Arc> euler;
 
@@ -166 +166 @@
     ///Constructor
 
-    ///\param _g An graph.
+    ///\param gr An graph.
     ///\param start The starting point of the tour. If it is not given
     ///       the tour will start from the first node.
-    EulerIt(const Digraph &_g,typename Digraph::Node start=INVALID)
-      : g(_g), nedge(g), visited(g,false)
+    EulerIt(const GR &gr, typename GR::Node start = INVALID)
+      : g(gr), nedge(g), visited(g, false)
     {
       if(start==INVALID) start=NodeIt(g);
@@ -239 +239 @@
   ///for each node. <em>Therefore, there are digraphs which are not Eulerian,
   ///but still have an Euler tour</em>.
-  template<class Digraph>
+  template<typename GR>
 #ifdef DOXYGEN
   bool
 #else
-  typename enable_if<UndirectedTagIndicator<Digraph>,bool>::type
-  eulerian(const Digraph &g)
-  {
-    for(typename Digraph::NodeIt n(g);n!=INVALID;++n)
+  typename enable_if<UndirectedTagIndicator<GR>,bool>::type
+  eulerian(const GR &g)
+  {
+    for(typename GR::NodeIt n(g);n!=INVALID;++n)
       if(countIncEdges(g,n)%2) return false;
     return connected(g);
   }
-  template<class Digraph>
-  typename disable_if<UndirectedTagIndicator<Digraph>,bool>::type
+  template<class GR>
+  typename disable_if<UndirectedTagIndicator<GR>,bool>::type
 #endif
-  eulerian(const Digraph &g)
-  {
-    for(typename Digraph::NodeIt n(g);n!=INVALID;++n)
+  eulerian(const GR &g)
+  {
+    for(typename GR::NodeIt n(g);n!=INVALID;++n)
       if(countInArcs(g,n)!=countOutArcs(g,n)) return false;
-    return connected(Undirector<const Digraph>(g));
+    return connected(Undirector<const GR>(g));
   }