getting_started.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Mon, 01 Mar 2010 02:30:00 +0100
changeset 58 10b6a5b7d4c0
parent 32 ef12f83752f6
permissions -rw-r--r--
Improve Algorithms section (it is still under construction)
kpeter@3
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@3
     2
 *
kpeter@3
     3
 * This file is a part of LEMON, a generic C++ optimization library.
kpeter@3
     4
 *
kpeter@32
     5
 * Copyright (C) 2003-2010
kpeter@3
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@3
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@3
     8
 *
kpeter@3
     9
 * Permission to use, modify and distribute this software is granted
kpeter@3
    10
 * provided that this copyright notice appears in all copies. For
kpeter@3
    11
 * precise terms see the accompanying LICENSE file.
kpeter@3
    12
 *
kpeter@3
    13
 * This software is provided "AS IS" with no warranty of any kind,
kpeter@3
    14
 * express or implied, and with no claim as to its suitability for any
kpeter@3
    15
 * purpose.
kpeter@3
    16
 *
kpeter@3
    17
 */
kpeter@3
    18
kpeter@11
    19
namespace lemon {
kpeter@3
    20
/**
kpeter@26
    21
[PAGE]sec_hello_lemon[PAGE] Compile Your First Code
kpeter@6
    22
kpeter@25
    23
First of all, you have to install LEMON on your system (see the
kpeter@25
    24
<a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>Installation
kpeter@25
    25
Guide</b></a> for instructions).
kpeter@25
    26
In this section, we assume that you use a Linux environment and
kpeter@25
    27
<a href="http://gcc.gnu.org/">GCC</a> compiler.
kpeter@25
    28
kpeter@25
    29
Once you have installed the library, you may paste the following code segment
kpeter@25
    30
into a file <tt>hello_lemon.cc</tt> to have a first working program that uses
kpeter@25
    31
LEMON.
kpeter@6
    32
kpeter@6
    33
\dontinclude hello_lemon.cc
kpeter@6
    34
\skip #include
kpeter@6
    35
\until }
kpeter@6
    36
kpeter@25
    37
In this small example, a directed graph is created with two nodes and
kpeter@16
    38
an arc added to it.
kpeter@6
    39
kpeter@16
    40
Now let us compile this code.
kpeter@16
    41
(We suppose that you have it in a file called <tt>hello_lemon.cc</tt>.)
kpeter@6
    42
kpeter@16
    43
If LEMON is installed <b>system-wide</b> (into directory \c /usr/local),
kpeter@9
    44
then it is very easy to compile this program with the
kpeter@6
    45
following command (the argument <tt>-lemon</tt> tells the compiler
kpeter@16
    46
that we are using the installed LEMON).
kpeter@6
    47
kpeter@6
    48
\verbatim
deba@23
    49
g++ -o hello_lemon hello_lemon.cc -lemon
kpeter@6
    50
\endverbatim
kpeter@6
    51
kpeter@57
    52
As a result you will get the executable \c hello_lemon in the current
kpeter@6
    53
directory, which you can run by the following command.
kpeter@6
    54
kpeter@6
    55
\verbatim
kpeter@6
    56
./hello_lemon
kpeter@6
    57
\endverbatim
kpeter@6
    58
kpeter@16
    59
If LEMON is installed <b>user-local</b> into a directory
kpeter@18
    60
(e.g. <tt>~/lemon</tt>), then compiling the code is a bit more difficult.
kpeter@6
    61
You have to issue a command like this.
kpeter@6
    62
kpeter@6
    63
\verbatim
deba@23
    64
g++ -o hello_lemon -I ~/lemon/include hello_lemon.cc -L ~/lemon/lib -lemon
kpeter@6
    65
\endverbatim
kpeter@6
    66
kpeter@6
    67
If everything has gone well, then our program prints out the followings.
kpeter@6
    68
kpeter@6
    69
\verbatim
kpeter@16
    70
Hello World! This is LEMON library here.
kpeter@16
    71
We have a directed graph with 2 nodes and 1 arc.
kpeter@6
    72
\endverbatim
kpeter@6
    73
kpeter@6
    74
If you managed to compile and run this example code without any problems,
kpeter@16
    75
you may go on reading this tutorial to get to know the basic notions,
kpeter@25
    76
features and tools of LEMON. However, if you encountered problems that
kpeter@16
    77
you did not manage to solve, do not hesitate to
kpeter@6
    78
<a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.
kpeter@6
    79
alpar@10
    80
[TRAILER]
kpeter@3
    81
*/
kpeter@11
    82
}