Changeset 1522:321661278137 in lemon-0.x for doc/quicktour.dox

Timestamp:

06/28/05 19:46:35 (20 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Some corrections to graph_io.dox (mainly language corrections). Improvements on quicktour.

File:

• doc/quicktour.dox (modified) (5 diffs)

doc/quicktour.dox

@@ -25 +25 @@
 Some examples are the following (you will find links next to the code fragments that help to download full demo programs: save them on your computer and compile them according to the description in the page about \ref getsart How to start using LEMON):
 
-<ul>
-<li> First we give two examples that show how to instantiate a graph. The
-first one shows the methods that add nodes and edges, but one will
-usually use the second way which reads a graph from a stream (file).
-<ol>
-<li>The following code fragment shows how to fill a graph with data. It creates a complete graph on 4 nodes. The type Listgraph is one of the LEMON graph types: the typedefs in the beginning are for convenience and we will suppose them later as well.
- \code
-  typedef ListGraph Graph;
+<ul> <li> The first thing to discuss is the way one can create data structures
+like graphs and maps in a program using LEMON. 
+//There are more graph types
+//implemented in LEMON and you can implement your own graph type just as well:
+//read more about this in the already mentioned page on \ref graphs "graphs".
+
+First we show how to add nodes and edges to a graph manually. We will also
+define a map on the edges of the graph. After this we show the way one can
+read a graph (and perhaps maps on it) from a stream (e.g. a file). Of course
+we also have routines that write a graph (and perhaps maps) to a stream
+(file): this will also be shown. LEMON supports the DIMACS file formats to
+store network optimization problems, but more importantly we also have our own
+file format that gives a more flexible way to store data related to network
+optimization.
+
+<ol> <li>The following code fragment shows how to fill a graph with
+data. It creates a complete graph on 4 nodes. The type Listgraph is one of the
+LEMON graph types: the typedefs in the beginning are for convenience and we
+will suppose them later as well.  
+
+\code 
+
+  typedef ListGraph Graph; 
   typedef Graph::NodeIt NodeIt;
 
@@ -43 +58 @@
     for (NodeIt j(g); j!=INVALID; ++j)
       if (i != j) g.addEdge(i, j);
- \endcode 
+
+\endcode 
 
 See the whole program in file \ref helloworld.cc.
@@ -49 +65 @@
     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). LEMON supports the DIMACS file format: it can read a graph instance from a file 
-in that format (find the documentation of the DIMACS file format on the web). 
+<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
 Graph g;
@@ -56 +73 @@
 readDimacs(f, g);
 \endcode
-One can also store network (graph+capacity on the edges) instances and other things in DIMACS format and use these in LEMON: to see the details read the documentation of the \ref dimacs.h "Dimacs file format reader".
+
+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,
+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
+graph file format and input-output routines \ref graph-io-page here.
+
+So here is a file describing a graph of 10 nodes (0 to 9), two nodemaps
+(called \c coordinates_x and \c coordinates_y), several edges, an edge map
+called \c length and two designated nodes (called \c source and \c target).
+
+\todo Maybe another example would be better here.
+
+\code
+@nodeset
+id      coordinates_x   coordinates_y   
+9       447.907 578.328 
+8       79.2573 909.464 
+7       878.677 960.04  
+6       11.5504 938.413 
+5       327.398 815.035 
+4       427.002 954.002 
+3       148.549 753.748 
+2       903.889 326.476 
+1       408.248 577.327 
+0       189.239 92.5316 
+@edgeset
+                length  
+2       3       901.074 
+8       5       270.85  
+6       9       601.553 
+5       9       285.022 
+9       4       408.091 
+3       0       719.712 
+7       5       612.836 
+0       4       933.353 
+5       0       778.871 
+5       5       0       
+7       1       664.049 
+5       5       0       
+0       9       560.464 
+4       8       352.36  
+4       9       399.625 
+4       1       402.171 
+1       2       591.688 
+3       8       182.376 
+4       5       180.254 
+3       1       345.283 
+5       4       184.511 
+6       2       1112.45 
+0       1       556.624 
+@nodes
+source  1       
+target  8       
+@end
+\endcode
+
+Finally let us give a simple example that reads a graph from a file and writes
+it to another.
+
+\todo This is to be done!
 
 </ol>
@@ -63 +145 @@
 usually solved using Dijkstra's algorithm. A utility
 that solves this is  the \ref lemon::Dijkstra "LEMON Dijkstra class".
-The following code is a simple program using the \ref lemon::Dijkstra "LEMON
-Dijkstra class" and it also shows how to define a map on the edges (the length
+The following code is a simple program using the 
+\ref lemon::Dijkstra "LEMON Dijkstra class" and it also shows how to define a map on the edges (the length
 function):