COIN-OR::LEMON - Graph Library

source: lemon-0.x/doc/getstart.dox @ 1519:17e367a93cbb

Last change on this file since 1519:17e367a93cbb was 1519:17e367a93cbb, checked in by Mihaly Barasz, 14 years ago

getstart improvements

File size: 6.0 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\section requirementsLEMON Hardware and software requirements
13
14In LEMON we use C++ templates heavily, thus compilation takes a
15considerable amount of time and memory. So some decent box would be
16advantageous. But otherwise there are no special hardware requirements.
17
18You will need a recent C++ compiler. Our primary target is the GNU C++
19Compiler (g++), from version 3.3 upwards. We also checked the Intel C
20compiler (icc). Microsoft Visual C++ .NET version was also reported to
21work (but not the earlier versions). If you want to develop with LEMON
22under Windows you could consider using Cygwin.
23
24
25In this description we will suppose a linux environment and GNU C Compiler.
26
27\section downloadLEMON How to download LEMON
28
29You can download LEMON from the LEMON web site:
30http://lemon.cs.elte.hu/dowload.html.
31There you will find released versions in form of <tt>.tar.gz</tt> files.
32If you want a developer version (for example you want to contribute in
33developing the library LEMON) then you might want to use our Subversion
34repository. This case is not detailed here, so from now on we suppose that
35you downloaded a tar.gz file.
36
37
38
39\section installLEMON How to install LEMON
40
41In order to install LEMON you have to do the following
42
43Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x,\c y
44and \c z are numbers indicating the version of the library: in our example
45we will have <tt>lemon-0.3.1.tar.gz</tt>) and issue the following
46commands:
47
48\verbatim
49tar xvzf lemon-0.3.1.tar.gz
50cd lemon-0.3.1
51./configure
52make
53make check   #(This is optional, but recomended. It runs a bunch of tests.)
54make install
55\endverbatim
56
57These commands install LEMON under \c /usr/local (you will
58need root privileges to be able to install to that
59directory). If you want to install it to some other place, then
60pass the \c --prefix=DIR flag to \c ./configure. In what follows
61we 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
63library.
64
65We briefly explain these commands below.
66
67\verbatim
68tar xvzf lemon-0.3.1.tar.gz
69\endverbatim
70This command untars the <tt>tar.gz</tt> file into a directory named <tt>
71lemon-0.3.1</tt>.
72
73\verbatim
74cd lemon-0.3.1
75\endverbatim
76Enters the directory.
77
78\verbatim
79./configure
80\endverbatim
81Does some configuration (creates makefiles etc).
82\todo Explain the most important switches here (gui, doc, glpk, cplex).
83
84\verbatim
85make
86\endverbatim
87This command compiles the non-template part of LEMON into
88<b>libemon.a</b> file. It also compiles some benchmark and demo
89programs.
90
91\verbatim
92make check
93\endverbatim
94This is an optional step: it runs the test programs that we
95developed for LEMON to check whether the library works properly on
96your platform.
97
98\verbatim
99make install
100\endverbatim
101This 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
103be issued as "root", unless you provided a \c --prefix switch to
104the \c cofugure to install the library in non-default location.
105
106\section helloworld My first program using LEMON
107
108If you have installed LEMON on your system you can paste the
109following code segment into a file (named e.g. \c hello_lemon.cc)
110to have a first working program that uses library LEMON.
111
112\code
113#include <iostream>
114#include <lemon/list_graph.h>
115
116int main()
117{
118  typedef lemon::ListGraph Graph;
119  typedef Graph::EdgeIt EdgeIt;
120  typedef Graph::NodeIt NodeIt;
121  using lemon::INVALID;
122
123  Graph g;
124 
125  for (int i = 0; i < 3; i++)
126    g.addNode();
127 
128  for (NodeIt i(g); i!=INVALID; ++i)
129    for (NodeIt j(g); j!=INVALID; ++j)
130      if (i != j) g.addEdge(i, j);
131
132  std::cout << "Nodes:";
133  for (NodeIt i(g); i!=INVALID; ++i)
134    std::cout << " " << g.id(i);
135  std::cout << std::endl;
136
137  std::cout << "Edges:";
138  for (EdgeIt i(g); i!=INVALID; ++i)
139    std::cout << " (" << g.id(g.source(i)) << "," << g.id(g.target(i)) << ")";
140  std::cout << std::endl;
141}
142\endcode
143
144First let us briefly explain how this program works.
145
146ListGraph is one of LEMON's graph classes. It is based on linked lists,
147therefore iterating throuh its edges and nodes is fast.
148
149After some convenient typedefs we create a graph and add three nodes to it.
150Then we add edges to it to form a complete graph.
151
152Then we iterate through all nodes of the graph. We use a constructor of the
153node iterator to initialize it to the first node. The operator++ is used to
154step to the next node. Using operator++ on the iterator pointing to the last
155node invalidates the iterator i.e. sets its value to
156\ref lemon::INVALID "INVALID". This is what we exploit in the stop condition.
157
158We can also iterate through all edges of the graph very similarly. The
159\c target and
160\c source member functions can be used to access the endpoints of an edge.
161
162If you have saved the preceding code into a file named, say, \c
163hello_lemon.cc and your installation of LEMON into directory \c
164/usr/local was successful then it is very easy to compile this
165program with the following command (the argument <tt>-lemon</tt>
166tells the compiler that we are using the installed library LEMON):
167
168\verbatim
169g++ hello_lemon.cc -o hello_lemon -lemon
170\endverbatim
171
172As a result you will get the exacutable \c hello_lemon in
173this directory that you can run by the command
174\verbatim
175./hello_lemon
176\endverbatim
177
178
179If everything has gone well then the previous code fragment prints
180out the following:
181
182\verbatim
183Nodes: 2 1 0
184
185Edges: (0,2) (1,2) (0,1) (2,1) (1,0) (2,0)
186\endverbatim
187
188Congratulations!
189
190If you want to see more features, go to the
191\ref quicktour "Quick Tour to LEMON",
192if you want to see see some demo programs then go to our
193\ref demoprograms "Demo Programs" page!
194
195
196*/
Note: See TracBrowser for help on using the repository browser.