Changeset 1526:8c14aa8f27a2 in lemon-0.x for doc

Timestamp:

06/30/05 18:13:30 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Mainly doc review.

Location:

doc

Files:

• graph_io.dox (modified) (2 diffs)
• quicktour.dox (modified) (3 diffs)

doc/graph_io.dox

@@ -94 +94 @@
 
 The \c GraphWriter class provides the graph output. To write a graph
-you should first give writing commands for the writer. You can declare
+you should first give writing commands to the writer. You can declare
 write command as \c NodeMap or \c EdgeMap writing and labeled Node and
 Edge writing.
@@ -249 +249 @@
 
 The global functionality of the reader class can be changed by giving a
-special template parameter for the GraphReader class. By default, the
+special template parameter to the GraphReader class. By default, the
 template parameter is \c DefaultReaderTraits. A reader traits class 
 should provide an inner template class Reader for each type, and an 

doc/quicktour.dox

@@ -45 +45 @@
 will suppose them later as well.  
 
-\code 
-
-  typedef ListGraph Graph; 
-  typedef Graph::NodeIt NodeIt;
-
-  Graph g;
-  
-  for (int i = 0; i < 3; i++)
-    g.addNode();
-  
-  for (NodeIt i(g); i!=INVALID; ++i)
-    for (NodeIt j(g); j!=INVALID; ++j)
-      if (i != j) g.addEdge(i, j);
-
-\endcode 
-
-See the whole program in file \ref helloworld.cc.
-
-    If you want to read more on the LEMON graph structures and concepts, read the page about \ref graphs "graphs". 
-
-<li> The following code shows how to read a graph from a stream (e.g. a file)
-in the DIMACS file format (find the documentation of the DIMACS file formats on the web). 
+\dontinclude hello_lemon.cc
+\skip ListGraph
+\until addEdge
+
+See the whole program in file \ref hello_lemon.cc in \c demo subdir of
+LEMON package.
+
+    If you want to read more on the LEMON graph structures and
+concepts, read the page about \ref graphs "graphs".
+
+<li> The following code shows how to read a graph from a stream
+(e.g. a file) in the DIMACS file format (find the documentation of the
+DIMACS file formats on the web).
 
 \code
@@ -74 +65 @@
 \endcode
 
-One can also store network (graph+capacity on the edges) instances and other
-things (minimum cost flow instances etc.) in DIMACS format and use these in LEMON: to see the details read the
-documentation of the \ref dimacs.h "Dimacs file format reader". There you will
-also find the details about the output routines into files of the DIMACS
-format. 
-
-<li>We needed much greater flexibility than the DIMACS formats could give us,
+One can also store network (graph+capacity on the edges) instances and
+other things (minimum cost flow instances etc.) in DIMACS format and
+use these in LEMON: to see the details read the documentation of the
+\ref dimacs.h "Dimacs file format reader". There you will also find
+the details about the output routines into files of the DIMACS format.
+
+<li>DIMACS formats could not give us the flexibility we needed,
 so we worked out our own file format. Instead of any explanation let us give a
 short example file in this format: read the detailed description of the LEMON
@@ -240 +231 @@
 
 So far we have an
-interface for the commercial LP solver software \b CLPLEX (developed by ILOG)
+interface for the commercial LP solver software \b CPLEX (developed by ILOG)
 and for the open source solver \b GLPK (a shorthand for Gnu Linear Programming
 Toolkit).