Changeset 559:c5fd2d996909 in lemon-1.2 for lemon/lgf_reader.h

Timestamp:

03/29/09 23:08:20 (15 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/lgf_reader.h (modified) (3 diffs)

lemon/lgf_reader.h

@@ -449 +449 @@
   /// a single pass, because the arcs are not constructed when the node
   /// maps are read.
-  template <typename _Digraph>
+  template <typename GR>
   class DigraphReader {
   public:
 
-    typedef _Digraph Digraph;
+    typedef GR Digraph;
+
+  private:
+
     TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
-
-  private:
-
 
     std::istream* _is;
@@ -1247 +1247 @@
   /// arc map.  Similarly, an attribute can be read into an arc, if
   /// it's value is an edge label prefixed with \c '+' or \c '-'.
-  template <typename _Graph>
+  template <typename GR>
   class GraphReader {
   public:
 
-    typedef _Graph Graph;
+    typedef GR Graph;
+
+  private:
+
     TEMPLATE_GRAPH_TYPEDEFS(Graph);
-
-  private:
 
     std::istream* _is;
@@ -1357 +1358 @@
 
   private:
-    template <typename GR>
-    friend GraphReader<GR> graphReader(GR& graph, std::istream& is);
-    template <typename GR>
-    friend GraphReader<GR> graphReader(GR& graph, const std::string& fn); 
-    template <typename GR>
-    friend GraphReader<GR> graphReader(GR& graph, const char *fn);
+    template <typename Graph>
+    friend GraphReader<Graph> graphReader(Graph& graph, std::istream& is);
+    template <typename Graph>
+    friend GraphReader<Graph> graphReader(Graph& graph, const std::string& fn); 
+    template <typename Graph>
+    friend GraphReader<Graph> graphReader(Graph& graph, const char *fn);
 
     GraphReader(GraphReader& other)