COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/getstart.dox @ 2141:9bb0bfea2f0b

Last change on this file since 2141:9bb0bfea2f0b was 2125:2f2cbe4e78a8, checked in by Akos Ladanyi, 13 years ago

Removed references to the gui.

File size: 8.7 KB
Line 
1/**
2\page getstart How to start using LEMON
3
4In this page we detail how to start using LEMON, from downloading it to
5your computer, through the steps of installation, to showing a simple
6"Hello World" type program that already uses LEMON. We assume that you
7have a basic knowledge of your operating system and \c C++ programming
8language. The procedure is pretty straightforward, but if you have any
9difficulties don't hesitate to
10<a href="http://lemon.cs.elte.hu/mailinglists.html">ask</a>.
11
12
13\section requirementsLEMON Hardware and software requirements
14
15In LEMON we use C++ templates heavily, thus compilation takes a
16considerable amount of time and memory. So some decent box would be
17advantageous. But otherwise there are no special hardware requirements.
18
19You will need a recent C++ compiler. Our primary target is the GNU C++
20Compiler (g++), from version 3.3 upwards. We also checked the Intel C++
21Compiler (icc). Microsoft Visual C++ .NET 2003 was also reported to
22work (but not the earlier versions). If you want to develop with LEMON
23under Windows you could consider using Cygwin.
24
25In this description we will suppose a Linux environment and GNU C++ Compiler.
26
27
28\subsection requirementsLP LP solver requirements
29
30The LEMON LP solver interface can use the GLPK (GNU Linear Programming Kit)
31and CPLEX solvers (was tested with CPLEX 7.5). If you want to use it you will
32need at least one of these. See \ref configureFlags how to enable these at
33compile time.
34
35
36\subsection requirementsGUI GUI requirements
37
38To compile the graphical graph editor you will need libgnomecanvasmm
39(2.6.0 or newer). See \ref configureFlags how to enable it.
40
41
42\section downloadLEMON How to download LEMON
43
44You can download LEMON from the LEMON web site:
45http://lemon.cs.elte.hu/download.html .
46There you will find released versions in form of <tt>.tar.gz</tt> files.
47If you want a developer version (for example you want to contribute in
48developing the library LEMON) then you might want to use our Subversion
49repository. This case is not detailed here, so from now on we suppose that
50you downloaded a tar.gz file.
51
52
53\section installLEMON How to install LEMON
54
55In order to install LEMON you have to do the following steps.
56
57Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x,\c y
58and \c z are numbers indicating the version of the library: in our example
59we will have <tt>lemon-0.3.1.tar.gz</tt>) and issue the following
60commands:
61
62\verbatim
63tar xvzf lemon-0.3.1.tar.gz
64cd lemon-0.3.1
65./configure
66make
67make check   #(This is optional, but recommended. It runs a bunch of tests.)
68make install
69\endverbatim
70
71These commands install LEMON under \c /usr/local (you will
72need root privileges to be able to install to that
73directory). If you want to install it to some other place, then
74pass the \c --prefix=DIRECTORY flag to \c ./configure, for example:
75
76\verbatim
77./configure --prefix=/home/user1/lemon
78\endverbatim
79
80In what follows we will assume that you were able to install to directory
81\c /usr/local, otherwise some extra care is to be taken to use the
82library.
83
84We briefly explain these commands below.
85
86\verbatim
87tar xvzf lemon-0.3.1.tar.gz
88\endverbatim
89This command untars the <tt>tar.gz</tt> file into a directory named <tt>
90lemon-0.3.1</tt>.
91
92\verbatim
93cd lemon-0.3.1
94\endverbatim
95Enters the directory.
96
97\verbatim
98./configure
99\endverbatim
100Does some configuration (creates makefiles etc).
101
102\verbatim
103make
104\endverbatim
105This command compiles the non-template part of LEMON into
106<b>libemon.a</b> file. It also compiles some benchmark and demo
107programs.
108
109\verbatim
110make check
111\endverbatim
112This is an optional step: it runs the test programs that we
113developed for LEMON to check whether the library works properly on
114your platform.
115
116\verbatim
117make install
118\endverbatim
119This will copy the directory structure to its final destination (e.g. to \c
120/usr/local) so that your system can access it. This command should
121be issued as "root", unless you provided a \c --prefix switch to
122the \c configure to install the library in non-default location.
123
124
125\subsection configureFlags Configure flags
126
127You can pass the following flags to \c ./configure (see \c ./configure --help
128for more):
129
130\verbatim
131--with-glpk[=PREFIX]
132\endverbatim
133Enable GLPK support (default). You should specify the prefix too if you
134installed it to some non-standard location (e.g. your home directory). If
135GLPK is not found, then GLPK support will be disabled.
136
137\verbatim
138--with-glpk-includedir=DIR
139\endverbatim
140The directory where the GLPK header files are located. This is only useful when
141the GLPK headers and libraries are not under the same prefix (which is
142unlikely).
143
144\verbatim
145--with-glpk-libdir=DIR
146\endverbatim
147The directory where the GLPK libraries are located. This is only useful when
148the GLPK headers and libraries are not under the same prefix (which is
149unlikely).
150
151\verbatim
152--without-glpk
153\endverbatim
154Disable GLPK support.
155
156\verbatim
157--with-cplex[=PREFIX]
158\endverbatim
159Enable CPLEX support (default). You should specify the prefix too if you
160installed it to some non-standard location (e.g. \c /opt/ilog/cplex75). If
161CPLEX is not found, then CPLEX support will be disabled.
162
163\verbatim
164--with-cplex-includedir=DIR
165\endverbatim
166The directory where the CPLEX header files are located. This is only useful
167when the CPLEX headers and libraries are not under the same prefix.
168
169\verbatim
170--with-cplex-libdir=DIR
171\endverbatim
172The directory where the CPLEX libraries are located. This is only useful when
173the CPLEX headers and libraries are not under the same prefix.
174
175\verbatim
176--without-cplex
177\endverbatim
178Disable CPLEX support.
179
180
181\section svnCheckout How to checkout LEMON form our Subversion repository
182
183You can obtain the latest version of LEMON from our Subversion repository. To
184do this issue the following command:
185\verbatim
186svn co https://lemon.cs.elte.hu/svn/hugo/trunk lemon
187\endverbatim
188Use "lemon" as username, the password is empty.
189
190
191\section svnCompile How to compile the source from the repository
192
193You can compile the code from the repository similarly to the packaged version,
194but you will need to run \c ./bootstrap before \c ./configure. See \c
195./bootstrap \c --help for options. For bootstrapping you will need the
196following tools:
197
198 - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
199 - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
200 - <a href="http://www.gnu.org/software/libtool/">libtool</a>
201 - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
202
203To generate the documentation, run \c make \c doc. You will need
204<a href="http://www.doxygen.org/">Doxygen</a> for this.
205
206You can pass the \c --enable-doc=full flag to \c ./configure to generate the
207internal documentation too.
208
209If you pass the \c --disable-doc flag to \c ./configure then the documentation
210won't be installed, when you run \c make \c install (this speeds things up a
211bit).
212
213\section helloworld My first program using LEMON
214
215If you have installed LEMON on your system you can paste the
216following code segment into a file (you can find it as \c
217demo/hello_lemon.cc in the LEMON package) to have a first working
218program that uses library LEMON.
219
220\dontinclude hello_lemon.cc
221\skip include
222\until }
223
224First let us briefly explain how this program works.
225
226ListGraph is one of LEMON's graph classes. It is based on linked lists,
227therefore iterating throuh its edges and nodes is fast.
228
229After some convenience typedefs we create a graph and add three nodes to it.
230Then we add edges to it to form a complete graph.
231
232Then we iterate through all nodes of the graph. We use a constructor of the
233node iterator to initialize it to the first node. The operator++ is used to
234step to the next node. Using operator++ on the iterator pointing to the last
235node invalidates the iterator i.e. sets its value to
236\ref lemon::INVALID "INVALID". This is what we exploit in the stop condition.
237
238We can also iterate through all edges of the graph very similarly. The
239\c target and
240\c source member functions can be used to access the endpoints of an edge.
241
242If your installation of LEMON into directory \c /usr/local was
243successful, then it is very easy to compile this program with the
244following command (the argument <tt>-lemon</tt> tells the compiler
245that we are using the installed library LEMON):
246
247\verbatim
248g++ hello_lemon.cc -o hello_lemon -lemon
249\endverbatim
250
251As a result you will get the exacutable \c hello_lemon in
252this directory that you can run by the command
253\verbatim
254./hello_lemon
255\endverbatim
256
257
258If everything has gone well then the previous code fragment prints
259out the following:
260
261\verbatim
262Nodes: 2 1 0
263
264Edges: (0,2) (1,2) (0,1) (2,1) (1,0) (2,0)
265\endverbatim
266
267Congratulations!
268
269If you want to see more features, go to the
270\ref quicktour "Quick Tour to LEMON",
271if you want to see see some demo programs then go to our
272\ref demoprograms "Demo Programs" page!
273
274
275*/
Note: See TracBrowser for help on using the repository browser.