COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/quicktour.dox @ 1578:1d3a1bcbc874

Last change on this file since 1578:1d3a1bcbc874 was 1578:1d3a1bcbc874, checked in by zsuzska, 15 years ago

kruskal_demo corrected, quicktour filled with kruskal

File size: 9.5 KB
Line 
1/**
2
3\page quicktour Quick Tour to LEMON
4
5Let us first answer the question <b>"What do I want to use LEMON for?"
6</b>.
7LEMON is a C++ library, so you can use it if you want to write C++
8programs. What kind of tasks does the library LEMON help to solve?
9It helps to write programs that solve optimization problems that arise
10frequently when <b>designing and testing certain networks</b>, for example
11in telecommunication, computer networks, and other areas that I cannot
12think of now. A very natural way of modelling these networks is by means
13of a <b> graph</b> (we will always mean a directed graph by that and say
14<b> undirected graph </b> otherwise).
15So if you want to write a program that works with
16graphs then you might find it useful to use our library LEMON. LEMON
17defines various graph concepts depending on what you want to do with the
18graph: a very good description can be found in the page
19about \ref graphs "graphs".
20
21You will also want to assign data to the edges or nodes of the graph, for
22example a length or capacity function defined on the edges. You can do this in
23LEMON 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".
24
25In 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.
26You 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".
27
28Have fun!
29
30<ul> <li> The first thing to discuss is the way one can create data structures
31like graphs and maps in a program using LEMON.
32//There are more graph types
33//implemented in LEMON and you can implement your own graph type just as well:
34//read more about this in the already mentioned page on \ref graphs "graphs".
35
36First we show how to add nodes and edges to a graph manually. We will also
37define a map on the edges of the graph. After this we show the way one can
38read a graph (and perhaps maps on it) from a stream (e.g. a file). Of course
39we also have routines that write a graph (and perhaps maps) to a stream
40(file): this will also be shown. LEMON supports the DIMACS file formats to
41read network optimization problems, but more importantly we also have our own
42file format that gives a more flexible way to store data related to network
43optimization.
44
45<ol> <li>The following code shows how to build a graph from scratch
46and iterate on its nodes and edges.  This example also shows how to
47give a map on the edges of the graph.  The type Listgraph is one of
48the LEMON graph types: the typedefs in the beginning are for
49convenience and we will assume them later as well.
50
51\include hello_lemon.cc
52
53See the whole program in file \ref hello_lemon.cc in the \c demo subdir of
54LEMON package.
55
56    If you want to read more on the LEMON graph structures and
57concepts, read the page about \ref graphs "graphs".
58
59
60<li>LEMON has an own file format for storing graphs, maps on edges/nodes and some other things. Instead of any explanation let us give a
61short example file in this format: read the detailed description of the LEMON
62graph file format and input-output routines here: \ref graph-io-page.
63
64So here is a file describing a graph of 6 nodes (0 to 5), two nodemaps
65(called \c coordinates_x and \c coordinates_y), several edges, an edge map
66called \c capacity and two designated nodes (called \c source and \c target).
67
68\verbatim
69@nodeset
70id      coordinates_x   coordinates_y
715       796.398 208.035
724       573.002 63.002
733       568.549 401.748
742       277.889 68.476
751       288.248 397.327
760       102.239 257.532
77@edgeset
78                id      capacity
794       5       6       8
803       5       5       8
812       4       4       5
821       4       3       8
831       3       2       5
840       2       1       10
850       1       0       10
86#This is a comment here
87@nodes
88source 0
89target 5
90@edges
91@attributes
92author "Attila BERNATH"
93@end
94\endverbatim
95
96Finally let us give a simple example that reads a graph from a file and writes
97it to the standard output.
98
99\include reader_writer_demo.cc
100
101See the whole program in file \ref reader_writer_demo.cc.
102
103<li> The following code shows how to read a graph from a stream
104(e.g. a file) in the DIMACS file format (find the documentation of the
105DIMACS file formats on the web).
106
107\code
108Graph g;
109std::ifstream f("graph.dim");
110readDimacs(f, g);
111\endcode
112
113One can also store network (graph+capacity on the edges) instances and
114other things (minimum cost flow instances etc.) in DIMACS format and
115read these in LEMON: to see the details read the documentation of the
116\ref dimacs.h "Dimacs file format reader".
117
118</ol>
119<li> If you want to solve some transportation problems in a network then
120you will want to find shortest paths between nodes of a graph. This is
121usually solved using Dijkstra's algorithm. A utility
122that solves this is  the \ref lemon::Dijkstra "LEMON Dijkstra class".
123The following code is a simple program using the
124\ref lemon::Dijkstra "LEMON Dijkstra class": it calculates the shortest path between node \c s and \c t in a graph \c g.
125We omit the part reading the graph  \c g and the length map \c len.
126
127\dontinclude dijkstra_demo.cc
128\skip ListGraph
129\until Graph g
130...
131\skip Dijkstra algorithm
132\until std::cout << g.id(s)
133
134See the whole program in \ref dijkstra_demo.cc.
135
136Some explanation: after instantiating a member of the Dijkstra class
137we run the Dijkstra algorithm from node \c s. After this we read some
138of the results.  You can do much more with the Dijkstra class, for
139example you can run it step by step and gain full control of the
140execution. For a detailed description, see the documentation of the
141\ref lemon::Dijkstra "LEMON Dijkstra class".
142
143
144<li> If you want to design a network and want to minimize the total
145length of wires then you might be looking for a <b>minimum spanning
146tree</b> in an undirected graph. This can be found using the Kruskal
147algorithm: the function \ref lemon::kruskal "LEMON Kruskal " does
148this job for you.  After we had a graph \c g and a cost map \c
149edge_cost_map , the following code fragment shows an example how to get weight of the minmum spanning tree, if the costs are uniform:
150
151\dontinclude kruskal_demo.cc
152\skip std::cout
153\until kruskal
154
155It gives back a edge bool map, which contains the edges of the tree.
156If the costs are non-uniform, for example  the cost is given by \c
157edge_cost_map_2 , or the edges of the tree are have to be given in a
158vector, then we can give to the kruskal a vector \c tree_edge_vec , instead of
159an edge bool map:
160
161\skip edge_cost_map_2
162\until edge_cost_map_2, std::back_inserter
163
164And finally the next fragment shows how to use the functions \c makeKruskalMapInput and \c makeKruskalSequenceOutPut:
165
166\skip makeKruskalSequenceOutput
167\until tree_edge_vec
168
169See the whole program in \ref kruskal_demo.cc.
170
171
172
173<li>Many problems in network optimization can be formalized by means
174of a linear programming problem (LP problem, for short). In our
175library we decided not to write an LP solver, since such packages are
176available in the commercial world just as well as in the open source
177world, and it is also a difficult task to compete these. Instead we
178decided to develop an interface that makes it easier to use these
179solvers together with LEMON. The advantage of this approach is
180twofold. Firstly our C++ interface is more comfortable than the
181solvers' native interface. Secondly, changing the underlying solver in
182a certain software using LEMON's LP interface needs zero effort. So,
183for example, one may try his idea using a free solver, demonstrate its
184usability for a customer and if it works well, but the performance
185should be improved, then one may decide to purchase and use a better
186commercial solver.
187
188So far we have an
189interface for the commercial LP solver software \b CPLEX (developed by ILOG)
190and for the open source solver \b GLPK (a shorthand for Gnu Linear Programming
191Toolkit).
192
193We will show two examples, the first one shows how simple it is to formalize
194and solve an LP problem in LEMON, while the second one shows how LEMON
195facilitates solving network optimization problems using LP solvers.
196
197<ol>
198<li>The following code shows how to solve an LP problem using the LEMON lp
199interface. The code together with the comments is self-explanatory.
200
201\dontinclude lp_demo.cc
202\skip A default solver is taken
203\until End of LEMON style code
204
205See the whole code in \ref lp_demo.cc.
206
207<li>The second example shows how easy it is to formalize a max-flow
208problem as an LP problem using the LEMON LP interface: we are looking
209for a real valued function defined on the edges of the digraph
210satisfying the nonnegativity-, the capacity constraints and the
211flow-conservation constraints and giving the largest flow value
212between to designated nodes.
213
214In the following code we suppose that we already have the graph \c g,
215the capacity map \c cap, the source node \c s and the target node \c t
216in the memory. We will also omit the typedefs.
217
218\dontinclude lp_maxflow_demo.cc
219\skip Define a map on the edges for the variables of the LP problem
220\until lp.max();
221\skip Solve with the underlying solver
222\until lp.solve();
223
224
225The complete program can be found in file \ref lp_maxflow_demo.cc. After compiling run it in the form:
226
227<tt>./lp_maxflow_demo < sample.lgf</tt>
228
229where sample.lgf is a file in the lemon format containing a maxflow instance (designated "source", "target" nodes and "capacity" map on the edges).
230
231
232
233</ol>
234</ul>
235
236*/
Note: See TracBrowser for help on using the repository browser.