1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2008
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
20 \page hello_lemon Compile Your First Code
22 If you have installed LEMON on your system you can paste the following
23 code segment into a file called <tt>hello_lemon.cc</tt> to have a first
24 working program that uses LEMON.
26 \dontinclude hello_lemon.cc
30 First let us briefly explain how this example program works.
31 (The used notions will be discussed in detail in the following sections.)
33 After some convenience typedefs we create a directed graph (\e digraph)
34 and add some nodes and arcs to it.
35 ListDigraph is one of the digraph classes implemented in LEMON.
36 It is based on linked lists, therefore iterating through its nodes and
39 Then we iterate through all nodes of the digraph and print their unique
40 IDs. We use a constructor of the node iterator to initialize it to the
42 The <tt>operator++</tt> is used to step to the next node. After the last
43 node the iterator becomes invalid (i.e. it is set to \c INVALID).
44 This is what we exploit in the stop condition.
45 We iterate through all arcs of the digraph very similarly and print the
46 IDs of their source (tail) and target (head) nodes using the \c source()
47 and \c target() member functions.
49 After that we create an arc map, which is actually a mapping that assigns
50 an \c int value (length) to each arc, and we set this value for each arc.
51 Finally we iterate through all arcs again and print their lengths.
53 Now let us compile this simple example program.
55 \section hello_lemon_system If LEMON is Installed System-Wide
57 If LEMON is installed system-wide (into directory \c /usr/local),
58 then it is very easy to compile this program with the
59 following command (the argument <tt>-lemon</tt> tells the compiler
60 that we are using the installed LEMON):
63 g++ -lemon hello_lemon.cc -o hello_lemon
66 As a result you will get the exacutable \c hello_lemon in the current
67 directory, which you can run by the following command.
73 \section hello_lemon_user If LEMON is Installed User-Local
75 Compiling the code is a bit more difficult if you installed LEMON
76 user-local into a directory (e.g. <tt>~/lemon</tt>) or if you just
77 skipped the step <tt>make install</tt>.
78 You have to issue a command like this.
81 g++ -lemon -I ~/lemon -L ~/lemon/lemon/.libs hello_lemon.cc -o hello_lemon
84 If everything has gone well, then our program prints out the followings.
88 This is LEMON library here. We have a direceted graph.
91 Arcs: (2,3) (1,3) (1,2) (0,2) (0,1)
93 There is a map on the arcs (length):
102 You may note that iterating through the nodes and arcs is done in the
103 reverse order compared to the creating order (the IDs are in decreasing
105 This is due to implementation aspects, that may differ at other graph
106 types, moreover it may be changed in the next releases.
107 Thus you should not exploit this method in any way, you should not
108 suppose anything about the iteration order.
110 If you managed to compile and run this example code without any problems,
111 you can go on reading this tutorial to get to know more features and tools
113 Otherwise if you encountered problems that you did not manage to solve,
115 <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.