getting_started.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Mon, 03 Nov 2008 23:46:30 +0100
changeset 16 ed4c8506e151
parent 12 d64ffbd7d8c6
child 18 a291609dad52
permissions -rw-r--r--
Simplify the first example code + fix toc
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@3
     5
 * Copyright (C) 2003-2008
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
/**
alpar@10
    21
[PAGE]hello_lemon[PAGE] Compile Your First Code
kpeter@6
    22
kpeter@11
    23
First of all you have to install LEMON on your system (see
kpeter@11
    24
\ref install for instructions).
kpeter@11
    25
After that you can paste the following code segment into a file
kpeter@11
    26
<tt>hello_lemon.cc</tt> to have a first working program that uses LEMON.
kpeter@6
    27
kpeter@6
    28
\dontinclude hello_lemon.cc
kpeter@6
    29
\skip #include
kpeter@6
    30
\until }
kpeter@6
    31
kpeter@16
    32
In this small example a directed graph is created with two nodes and
kpeter@16
    33
an arc added to it.
kpeter@6
    34
kpeter@16
    35
Now let us compile this code.
kpeter@16
    36
(We suppose that you have it in a file called <tt>hello_lemon.cc</tt>.)
kpeter@6
    37
kpeter@16
    38
If LEMON is installed <b>system-wide</b> (into directory \c /usr/local),
kpeter@9
    39
then it is very easy to compile this program with the
kpeter@6
    40
following command (the argument <tt>-lemon</tt> tells the compiler
kpeter@16
    41
that we are using the installed LEMON).
kpeter@6
    42
kpeter@6
    43
\verbatim
kpeter@9
    44
g++ -lemon hello_lemon.cc -o hello_lemon
kpeter@6
    45
\endverbatim
kpeter@6
    46
kpeter@6
    47
As a result you will get the exacutable \c hello_lemon in the current
kpeter@6
    48
directory, which you can run by the following command.
kpeter@6
    49
kpeter@6
    50
\verbatim
kpeter@6
    51
./hello_lemon
kpeter@6
    52
\endverbatim
kpeter@6
    53
kpeter@16
    54
If LEMON is installed <b>user-local</b> into a directory
kpeter@16
    55
(e.g. <tt>~/lemon</tt>) or if you just skipped the step
kpeter@16
    56
<tt>make install</tt>, then compiling the code is a bit more difficult.
kpeter@6
    57
You have to issue a command like this.
kpeter@6
    58
kpeter@6
    59
\verbatim
kpeter@9
    60
g++ -lemon -I ~/lemon -L ~/lemon/lemon/.libs hello_lemon.cc -o hello_lemon
kpeter@6
    61
\endverbatim
kpeter@6
    62
kpeter@6
    63
If everything has gone well, then our program prints out the followings.
kpeter@6
    64
kpeter@6
    65
\verbatim
kpeter@16
    66
Hello World! This is LEMON library here.
kpeter@16
    67
We have a directed graph with 2 nodes and 1 arc.
kpeter@6
    68
\endverbatim
kpeter@6
    69
kpeter@6
    70
If you managed to compile and run this example code without any problems,
kpeter@16
    71
you may go on reading this tutorial to get to know the basic notions,
kpeter@16
    72
features and tools of LEMON. However if you encountered problems that
kpeter@16
    73
you did not manage to solve, do not hesitate to
kpeter@6
    74
<a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.
kpeter@6
    75
alpar@10
    76
[TRAILER]
kpeter@3
    77
*/
kpeter@11
    78
}