2 \page getstart How to start using LEMON
4 In this page we detail how to start using LEMON, from downloading it to
5 your computer, through the steps of installation, to showing a simple
6 "Hello World" type program that already uses LEMON. We assume that you
7 have a basic knowledge of your operating system and \c C++ programming
8 language. The procedure is pretty straightforward, but if you have any
9 difficulties don't hesitate to
10 <a href="http://lemon.cs.elte.hu/mailinglists.html">ask</a>.
12 \section requirementsLEMON Hardware and software requirements
14 In LEMON we use C++ templates heavily, thus compilation takes a
15 considerable amount of time and memory. So some decent box would be
16 advantageous. But otherwise there are no special hardware requirements.
18 You will need a recent C++ compiler. Our primary target is the GNU C++
19 Compiler (g++), from version 3.3 upwards. We also checked the Intel C
20 compiler (icc). Microsoft Visual C++ .NET version was also reported to
21 work (but not the earlier versions). If you want to develop with LEMON
22 under Windows you could consider using Cygwin.
25 In this description we will suppose a linux environment and GNU C Compiler.
27 \section downloadLEMON How to download LEMON
29 You can download LEMON from the LEMON web site:
30 http://lemon.cs.elte.hu/dowload.html.
31 There you will find released versions in form of <tt>.tar.gz</tt> files.
32 If you want a developer version (for example you want to contribute in
33 developing the library LEMON) then you might want to use our Subversion
34 repository. This case is not detailed here, so from now on we suppose that
35 you downloaded a tar.gz file.
39 \section installLEMON How to install LEMON
41 In order to install LEMON you have to do the following
43 Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x,\c y
44 and \c z are numbers indicating the version of the library: in our example
45 we will have <tt>lemon-0.3.1.tar.gz</tt>) and issue the following
49 tar xvzf lemon-0.3.1.tar.gz
53 make check #(This is optional, but recomended. It runs a bunch of tests.)
57 These commands install LEMON under \c /usr/local (you will
58 need root privileges to be able to install to that
59 directory). If you want to install it to some other place, then
60 pass the \c --prefix=DIR flag to \c ./configure. In what follows
61 we will assume that you were able to install to directory
62 \c /usr/local, otherwise some extra care is to be taken to use the
65 We briefly explain these commands below.
68 tar xvzf lemon-0.3.1.tar.gz
70 This command untars the <tt>tar.gz</tt> file into a directory named <tt>
81 Does some configuration (creates makefiles etc).
82 \todo Explain the most important switches here (gui, doc, glpk, cplex).
87 This command compiles the non-template part of LEMON into
88 <b>libemon.a</b> file. It also compiles some benchmark and demo
94 This is an optional step: it runs the test programs that we
95 developed for LEMON to check whether the library works properly on
101 This will copy the directory structure to its final destination (e.g. to \c
102 /usr/local) so that your system can access it. This command should
103 be issued as "root", unless you provided a \c --prefix switch to
104 the \c cofugure to install the library in non-default location.
106 \section helloworld My first program using LEMON
108 If you have installed LEMON on your system you can paste the
109 following code segment into a file (you can find it as \c
110 demo/hello_lemon.cc in the LEMON package) to have a first working
111 program that uses library LEMON.
113 \include hello_lemon.cc
115 First let us briefly explain how this program works.
117 ListGraph is one of LEMON's graph classes. It is based on linked lists,
118 therefore iterating throuh its edges and nodes is fast.
120 After some convenient typedefs we create a graph and add three nodes to it.
121 Then we add edges to it to form a complete graph.
123 Then we iterate through all nodes of the graph. We use a constructor of the
124 node iterator to initialize it to the first node. The operator++ is used to
125 step to the next node. Using operator++ on the iterator pointing to the last
126 node invalidates the iterator i.e. sets its value to
127 \ref lemon::INVALID "INVALID". This is what we exploit in the stop condition.
129 We can also iterate through all edges of the graph very similarly. The
131 \c source member functions can be used to access the endpoints of an edge.
133 If your installation of LEMON into directory \c /usr/local was
134 successful then it is very easy to compile this program with the
135 following command (the argument <tt>-lemon</tt> tells the compiler
136 that we are using the installed library LEMON):
139 g++ hello_lemon.cc -o hello_lemon -lemon
142 As a result you will get the exacutable \c hello_lemon in
143 this directory that you can run by the command
149 If everything has gone well then the previous code fragment prints
155 Edges: (0,2) (1,2) (0,1) (2,1) (1,0) (2,0)
160 If you want to see more features, go to the
161 \ref quicktour "Quick Tour to LEMON",
162 if you want to see see some demo programs then go to our
163 \ref demoprograms "Demo Programs" page!