Changeset 1181:848b6006941d in lemon-0.x for doc/quicktour.dox

Timestamp:

03/02/05 10:51:11 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Some work has been done in the quicktour.

File:

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

doc/quicktour.dox

@@ -17 +17 @@
 
 
-Some examples are the following:
+Some examples are the following (you will find links next to the code fragments that help to download full demo programs):
 
 - 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).
-
-
--# The following code fragment shows how to fill a graph with data.
-
+-# 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 supppose them later as well.
  \code
-
   typedef ListGraph Graph;
   typedef Graph::Edge Edge;
@@ -44 +40 @@
     for (NodeIt j(g); j!=INVALID; ++j)
       if (i != j) g.addEdge(i, j);
-
  \endcode 
 
- -#
+If you want to read more on the LEMON graph structures and concepts, read the page about \ref graphs "graphs". 
+
+-# 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 format on the web). 
+\code
+Graph g;
+std::ifstream f("graph.dim");
+readDimacs(f, g);
+\endcode
+One can also store network (graph+capacity on the edges) instances and other things in DIMACS format: to see the details read the documentation of the \ref dimacs.h "Dimacs file format reader".
+
 
 - If you want to solve some transportation problems in a network then 
@@ -54 +59 @@
 that solves this is  the \ref lemon::Dijkstra "LEMON Dijkstra class".
 A simple program using the \ref lemon::Dijkstra "LEMON Dijkstra class" is
-as follows (we assume that the graph is already given in the memory):
+as follows (we do not include the part that instantiates the graph and the length function):
 
 \code
-
+  typedef Graph::EdgeMap<int> LengthMap;
+  Graph G;
+  Node s, t;
+  LengthMap cap(G);
+        ...
+  Dijkstra<Graph, LengthMap> 
+        dijkstra_test(G, cap);
+  dijkstra_test.run(s);
 \endcode