# HG changeset patch # User deba # Date 1131993256 0 # Node ID 614ce2dd3cbac490bc085ec373f11b10d0b31ad8 # Parent 932b8490caf009b3772a1a9285f273515ac5a158 Some documentation modifications diff -r 932b8490caf0 -r 614ce2dd3cba doc/coding_style.dox --- a/doc/coding_style.dox Sun Nov 13 20:01:17 2005 +0000 +++ b/doc/coding_style.dox Mon Nov 14 18:34:16 2005 +0000 @@ -77,6 +77,12 @@ ClassNameEndsWithException \endcode +or + +\code +ClassNameEndsWithError +\endcode + \section header-template Template Header File Each LEMON header file should look like this: diff -r 932b8490caf0 -r 614ce2dd3cba doc/graph_io.dox --- a/doc/graph_io.dox Sun Nov 13 20:01:17 2005 +0000 +++ b/doc/graph_io.dox Mon Nov 14 18:34:16 2005 +0000 @@ -110,10 +110,6 @@ \section use Using graph input-output -The easiest way of using graph input and output is using the versions of the - public \ref readGraph() and \ref writeGraph() functions; if you don't need - very sophisticated behaviour then you might be satisfied with - those. Otherwise go on reading this page. The graph input and output is based on reading and writing commands. The user gives reading and writing commands to the reader or @@ -361,7 +357,7 @@ the \ref lemon::UndirGraphReader "UndirGraphReader" and \ref lemon::UndirGraphWriter "UndirGraphWriter". -The \ref lemon::UndirGraphReader::readUndirMap() "readUndirMap()" +The \ref lemon::UndirGraphReader::readUndirEdgeMap() "readUndirEdgeMap()" function reads an undirected map and the \ref lemon::UndirGraphReader::readUndirEdge() "readUndirEdge()" reads an undirected edge from the file, diff -r 932b8490caf0 -r 614ce2dd3cba doc/maps.dox --- a/doc/maps.dox Sun Nov 13 20:01:17 2005 +0000 +++ b/doc/maps.dox Mon Nov 14 18:34:16 2005 +0000 @@ -27,14 +27,14 @@ Each graph structure in LEMON provides two standard map templates called \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 length(G); + ListGraph::EdgeMap length(g); \endcode Note that you must give the underlying graph to the constructor. @@ -94,8 +94,6 @@ 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 { @@ -116,13 +114,13 @@ 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