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