Changeset 1788:614ce2dd3cba in lemon-0.x for doc/maps.dox

Timestamp:

11/14/05 19:34:16 (19 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2329

Message:

Some documentation modifications

File:

• doc/maps.dox (modified) (3 diffs)

doc/maps.dox

@@ -28 +28 @@
 \c EdgeMap and \c NodeMap. Both are reference maps and you can easily
 assign data to the nodes and to the edges of the graph. For example if you
-have a graph \c G defined as
+have a graph \c g defined as
 \code
-  ListGraph G;
+  ListGraph g;
 \endcode
 and you want to assign a floating point value to each edge, you can do
 it like this.
 \code
-  ListGraph::EdgeMap<double> length(G);
+  ListGraph::EdgeMap<double> length(g);
 \endcode
 Note that you must give the underlying graph to the constructor.
@@ -95 +95 @@
 An alternative way to define maps is to use \c MapBase
 
-\todo For this, \c MapBase seems to be a better name then \c NullMap.
-
 \code
 struct MyMap : public MapBase<Graph::Edge,double>
@@ -117 +115 @@
 public:
   Value operator[](Key e) const {
-    return orig_len.get(e)-(pot.get(G.target(e))-pot.get(G.source(e)));
+    return orig_len[e]-(pot[g.target(e)]-pot[g.source(e)]);
   }
   
   ReducedLengthMap(const Graph &_g,
-                   const Graph::EdgeMap &o,
-                   const Graph::NodeMap &p)
-    : G(g), orig_len(o), pot(p) {};
+                   const Graph::EdgeMap &_o,
+                   const Graph::NodeMap &_p)
+    : g(_g), orig_len(_o), pot(_p) {};
 };
 \endcode