Changeset 1528:1aa71600000c in lemon-0.x

Timestamp:

07/01/05 18:10:46 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Graph input-output demo, some documentation.

Files:

• demo/Makefile.am (modified) (2 diffs)
• demo/dijkstra_demo.cc (modified) (1 diff)
• demo/reader_writer_demo.cc (added)
• demo/sample.lgf (added)
• doc/getstart.dox (modified) (4 diffs)
• doc/quicktour.dox (modified) (5 diffs)

demo/Makefile.am

@@ -7 +7 @@
         dim_to_dot \
         dijkstra_demo \
+        reader_writer_demo \
         dim_to_lgf \
         graph_to_eps_demo \
@@ -27 +28 @@
 dijkstra_demo_SOURCES = dijkstra_demo.cc
 
+reader_writer_demo_SOURCES = reader_writer_demo.cc
+
 dim_to_lgf_SOURCES = dim_to_lgf.cc
 

demo/dijkstra_demo.cc

@@ -49 +49 @@
     std::cout << "Dijkstra algorithm test..." << std::endl;
 
-//     GraphWriter<ListGraph> writer(std::cout, g);
-//     writer.writeEdgeMap("capacity", len);
-//     writer.writeNode("source", s);
-//     writer.writeNode("target", t);
-//     writer.run();
 
     Dijkstra<Graph, LengthMap> dijkstra_test(g,len);

doc/getstart.dox

@@ -28 +28 @@
 
 You can download LEMON from the LEMON web site:
-http://lemon.cs.elte.hu/dowload.html.
+http://lemon.cs.elte.hu/download.html.
 There you will find released versions in form of <tt>.tar.gz</tt> files.
 If you want a developer version (for example you want to contribute in
@@ -39 +39 @@
 \section installLEMON How to install LEMON
 
-In order to install LEMON you have to do the following
+In order to install LEMON you have to do the following steps.
 
 Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x,\c y
@@ -51 +51 @@
 ./configure
 make
-make check   #(This is optional, but recomended. It runs a bunch of tests.)
+make check   #(This is optional, but recommended. It runs a bunch of tests.)
 make install
 \endverbatim
@@ -58 +58 @@
 need root privileges to be able to install to that
 directory). If you want to install it to some other place, then
-pass the \c --prefix=DIR flag to \c ./configure. In what follows
-we will assume that you were able to install to directory
+pass the \c --prefix=DIRECTORY flag to \c ./configure, for example:
+
+\verbatim
+./configure --prefix=/home/user1/lemon
+\endverbatim
+
+In what follows we will assume that you were able to install to directory
 \c /usr/local, otherwise some extra care is to be taken to use the
 library.

doc/quicktour.dox

@@ -23 +23 @@
 LEMON using so called \b maps. You can define a map on the nodes or on the edges of the graph and the value of the map (the range of the function) can be practically almost of any type. Read more about maps \ref maps-page "here".
 
-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):
+In this quick tour we want to show you some facilities LEMON library can provide through examples (simple demo programs). The examples will only show part of the functionality, but links will always be given to reach complete details. 
+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 getstart "How to start using LEMON". 
+
+Have fun!
 
 <ul> <li> The first thing to discuss is the way one can create data structures
@@ -80 +83 @@
 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
+\todo Maybe a shorter example would be better here.
+
+\include route.lgf
 
 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!
+it to the standard output.
+
+\include reader_writer_demo.cc
+
+See the whole program in file \ref reader_writer_demo.cc.
+
+\todo This is still under construction!
 
 </ol>
@@ -140 +105 @@
 function):
 
-\code
-
-    typedef ListGraph Graph;
-    typedef Graph::Node Node;
-    typedef Graph::Edge Edge;
-    typedef Graph::EdgeMap<int> LengthMap;
-
-    Graph g;
-
-    //An example from Ahuja's book
-
-    Node s=g.addNode();
-    Node v2=g.addNode();
-    Node v3=g.addNode();
-    Node v4=g.addNode();
-    Node v5=g.addNode();
-    Node t=g.addNode();
-
-    Edge s_v2=g.addEdge(s, v2);
-    Edge s_v3=g.addEdge(s, v3);
-    Edge v2_v4=g.addEdge(v2, v4);
-    Edge v2_v5=g.addEdge(v2, v5);
-    Edge v3_v5=g.addEdge(v3, v5);
-    Edge v4_t=g.addEdge(v4, t);
-    Edge v5_t=g.addEdge(v5, t);
-  
-    LengthMap len(g);
-
-    len.set(s_v2, 10);
-    len.set(s_v3, 10);
-    len.set(v2_v4, 5);
-    len.set(v2_v5, 8);
-    len.set(v3_v5, 5);
-    len.set(v4_t, 8);
-    len.set(v5_t, 8);
-
-    std::cout << "The id of s is " << g.id(s)<< std::endl;
-    std::cout <<"The id of t is " << g.id(t)<<"."<<std::endl;
-
-    std::cout << "Dijkstra algorithm test..." << std::endl;
-
-    Dijkstra<Graph, LengthMap> dijkstra_test(g,len);
-    
-    dijkstra_test.run(s);
-
-    
-    std::cout << "The distance of node t from node s: " << dijkstra_test.dist(t)<<std::endl;
-
-    std::cout << "The shortest path from s to t goes through the following nodes" <<std::endl;
- std::cout << " (the first one is t, the last one is s): "<<std::endl;
-
-    for (Node v=t;v != s; v=dijkstra_test.predNode(v)){
-        std::cout << g.id(v) << "<-";
-    }
-    std::cout << g.id(s) << std::endl;  
-\endcode
+\dontinclude dijkstra_demo.cc
+\skip ListGraph
+\until std::cout << g.id(s)
 
 See the whole program in \ref dijkstra_demo.cc.
@@ -210 +122 @@
 of wires then you might be looking for a <b>minimum spanning tree</b> in
 an undirected graph. This can be found using the Kruskal algorithm: the 
-class \ref lemon::Kruskal "LEMON Kruskal class" does this job for you.
+function \ref lemon::kruskal "LEMON Kruskal ..." does this job for you.
 The following code fragment shows an example:
 
@@ -337 +249 @@
 The complete program can be found in file \ref lp_maxflow_demo.cc. After compiling run it in the form:
 
-<tt>./lp_maxflow_demo < ?????????.lgf</tt>
-
-where ?????????.lgf is a file in the lemon format containing a maxflow instance (designated "source", "target" nodes and "capacity" map on the edges).
+<tt>./lp_maxflow_demo < sample.lgf</tt>
+
+where sample.lgf is a file in the lemon format containing a maxflow instance (designated "source", "target" nodes and "capacity" map on the edges).