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 <a href="mailto:etik-ol@cs.elte.hu">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 2003 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.
24 In this description we will suppose a Linux environment and GNU C++ Compiler.
27 \subsection requirementsLP LP solver requirements
29 The LEMON LP solver interface can use the GLPK (GNU Linear Programming Kit)
30 and CPLEX solvers (was tested with CPLEX 7.5). If you want to use it you will
31 need at least one of these. See \ref configureFlags how to enable these at
35 \section downloadLEMON How to download LEMON
37 You can download LEMON from the LEMON web site:
38 http://lemon.cs.elte.hu/download.html .
39 There you will find released versions in form of <tt>.tar.gz</tt> files.
40 If you want a developer version (for example you want to contribute in
41 developing the library LEMON) then you might want to use our Subversion
42 repository. This case is not detailed here, so from now on we suppose that
43 you downloaded a tar.gz file.
46 \section installLEMON How to install LEMON
48 In order to install LEMON you have to do the following steps.
50 Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x,\c y
51 and \c z are numbers indicating the version of the library: in our example
52 we will have <tt>lemon-0.3.1.tar.gz</tt>) and issue the following
56 tar xvzf lemon-0.3.1.tar.gz
60 make check #(This is optional, but recommended. It runs a bunch of tests.)
64 These commands install LEMON under \c /usr/local (you will
65 need root privileges to be able to install to that
66 directory). If you want to install it to some other place, then
67 pass the \c --prefix=DIRECTORY flag to \c ./configure, for example:
70 ./configure --prefix=/home/username/lemon
73 In what follows we will assume that you were able to install to directory
74 \c /usr/local, otherwise some extra care is to be taken to use the
77 We briefly explain these commands below.
80 tar xvzf lemon-0.3.1.tar.gz
82 This command untars the <tt>tar.gz</tt> file into a directory named <tt>
93 Does some configuration (creates makefiles etc).
98 This command compiles the non-template part of LEMON into
99 <b>libemon.a</b> file. It also compiles some benchmark and demo
105 This is an optional step: it runs the test programs that we
106 developed for LEMON to check whether the library works properly on
112 This will copy the directory structure to its final destination (e.g. to \c
113 /usr/local) so that your system can access it. This command should
114 be issued as "root", unless you provided a \c --prefix switch to
115 the \c configure to install the library in non-default location.
118 \subsection configureFlags Configure flags
120 You can pass the following flags to \c ./configure (see \c ./configure --help
126 Enable GLPK support (default). You should specify the prefix too if you
127 installed it to some non-standard location (e.g. your home directory). If
128 GLPK is not found, then GLPK support will be disabled.
131 --with-glpk-includedir=DIR
133 The directory where the GLPK header files are located. This is only useful when
134 the GLPK headers and libraries are not under the same prefix (which is
138 --with-glpk-libdir=DIR
140 The directory where the GLPK libraries are located. This is only useful when
141 the GLPK headers and libraries are not under the same prefix (which is
147 Disable GLPK support.
150 --with-cplex[=PREFIX]
152 Enable CPLEX support (default). You should specify the prefix too if you
153 installed it to some non-standard location (e.g. \c /opt/ilog/cplex75). If
154 CPLEX is not found, then CPLEX support will be disabled.
157 --with-cplex-includedir=DIR
159 The directory where the CPLEX header files are located. This is only useful
160 when the CPLEX headers and libraries are not under the same prefix.
163 --with-cplex-libdir=DIR
165 The directory where the CPLEX libraries are located. This is only useful when
166 the CPLEX headers and libraries are not under the same prefix.
171 Disable CPLEX support.
174 \section svnCheckout How to checkout LEMON form our Subversion repository
176 You can obtain the latest version of LEMON from our Subversion repository. To
177 do this issue the following command:
179 svn co https://lemon.cs.elte.hu/svn/hugo/trunk lemon
181 Use "lemon" as username, the password is empty.
184 \section svnCompile How to compile the source from the repository
186 You can compile the code from the repository similarly to the packaged version,
187 but you will need to run \c ./bootstrap before \c ./configure. See \c
188 ./bootstrap \c --help for options. For bootstrapping you will need the
191 - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
192 - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
193 - <a href="http://www.gnu.org/software/libtool/">libtool</a>
194 - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
196 To generate the documentation, run \c make \c doc. You will need
197 <a href="http://www.doxygen.org/">Doxygen</a> for this.
199 You can pass the \c --enable-doc=full flag to \c ./configure to generate the
200 internal documentation too.
202 If you pass the \c --disable-doc flag to \c ./configure then the documentation
203 won't be installed, when you run \c make \c install (this speeds things up a
206 \section helloworld My first program using LEMON
208 If you have installed LEMON on your system you can paste the
209 following code segment into a file (you can find it as \c
210 demo/hello_lemon.cc in the LEMON package) to have a first working
211 program that uses library LEMON.
213 \dontinclude hello_lemon.cc
217 First let us briefly explain how this program works.
219 ListGraph is one of LEMON's graph classes. It is based on linked lists,
220 therefore iterating throuh its edges and nodes is fast.
222 After some convenience typedefs we create a graph and add three nodes to it.
223 Then we add edges to it to form a complete graph.
225 Then we iterate through all nodes of the graph. We use a constructor of the
226 node iterator to initialize it to the first node. The operator++ is used to
227 step to the next node. Using operator++ on the iterator pointing to the last
228 node invalidates the iterator i.e. sets its value to
229 \ref lemon::INVALID "INVALID". This is what we exploit in the stop condition.
231 We can also iterate through all edges of the graph very similarly. The
233 \c source member functions can be used to access the endpoints of an edge.
235 If your installation of LEMON into directory \c /usr/local was
236 successful, then it is very easy to compile this program with the
237 following command (the argument <tt>-lemon</tt> tells the compiler
238 that we are using the installed library LEMON):
241 g++ hello_lemon.cc -o hello_lemon -lemon
244 As a result you will get the exacutable \c hello_lemon in
245 this directory that you can run by the command
251 If everything has gone well then the previous code fragment prints
257 Edges: (0,2) (1,2) (0,1) (2,1) (1,0) (2,0)
262 If you want to see more features, go to the
263 \ref quicktour "Quick Tour to LEMON",
264 if you want to see see some demo programs then go to our
265 \ref demoprograms "Demo Programs" page!