getting_started.dox
author Alpar Juttner <alpar@cs.elte.hu>
Mon, 23 Mar 2009 09:29:58 +0000
changeset 21 e4bd4ee05e3f
parent 19 9196fcd0d4d6
child 23 3e28dbeed635
permissions -rw-r--r--
Basic graph operation + intro to the default maps
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2009
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     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.
    12  *
    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
    15  * purpose.
    16  *
    17  */
    18 
    19 namespace lemon {
    20 /**
    21 [PAGE]hello_lemon[PAGE] Compile Your First Code
    22 
    23 First of all you have to install LEMON on your system (see
    24 <a href="http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide"><b>our
    25 web page</b></a> for instructions).
    26 After that you can paste the following code segment into a file
    27 <tt>hello_lemon.cc</tt> to have a first working program that uses LEMON.
    28 
    29 \dontinclude hello_lemon.cc
    30 \skip #include
    31 \until }
    32 
    33 In this small example a directed graph is created with two nodes and
    34 an arc added to it.
    35 
    36 Now let us compile this code.
    37 (We suppose that you have it in a file called <tt>hello_lemon.cc</tt>.)
    38 
    39 If LEMON is installed <b>system-wide</b> (into directory \c /usr/local),
    40 then it is very easy to compile this program with the
    41 following command (the argument <tt>-lemon</tt> tells the compiler
    42 that we are using the installed LEMON).
    43 
    44 \verbatim
    45 g++ -lemon -o hello_lemon hello_lemon.cc
    46 \endverbatim
    47 
    48 As a result you will get the exacutable \c hello_lemon in the current
    49 directory, which you can run by the following command.
    50 
    51 \verbatim
    52 ./hello_lemon
    53 \endverbatim
    54 
    55 If LEMON is installed <b>user-local</b> into a directory
    56 (e.g. <tt>~/lemon</tt>), then compiling the code is a bit more difficult.
    57 You have to issue a command like this.
    58 
    59 \verbatim
    60 g++ -lemon -I ~/lemon/include -L ~/lemon/lib -o hello_lemon hello_lemon.cc
    61 \endverbatim
    62 
    63 If everything has gone well, then our program prints out the followings.
    64 
    65 \verbatim
    66 Hello World! This is LEMON library here.
    67 We have a directed graph with 2 nodes and 1 arc.
    68 \endverbatim
    69 
    70 If you managed to compile and run this example code without any problems,
    71 you may go on reading this tutorial to get to know the basic notions,
    72 features and tools of LEMON. However if you encountered problems that
    73 you did not manage to solve, do not hesitate to
    74 <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.
    75 
    76 [TRAILER]
    77 */
    78 }