COIN-OR::LEMON - Graph Library

Changeset 1514:c9b9bc63db4e in lemon-0.x for doc/getstart.dox


Ignore:
Timestamp:
06/24/05 23:03:08 (14 years ago)
Author:
athos
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1998
Message:

Improved getsart.dox and quicktour.dox

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/getstart.dox

    r1511 r1514  
    44In this page we detail how to start using LEMON, from downloading it to
    55your computer, through the steps of installation to showing a simple
    6 "Hello World" type program that already uses LEMON. If anything is not
     6"Hello World" type program that already uses LEMON. We assume that you have a
     7basic knowledge of your operating system and \c C++ or \c C
     8programming language. If anything is not
    79clear write to our FAQ.
    810
     
    1012twice YES then a link comes here.
    1113
     14\section requirementsLEMON Hardware and software requirements
    1215
     16Hardware requirements ...
     17
     18You will also need a C++ compiler. We mostly used the Gnu C++ Compiler (g++),
     19from version 3.0 upwards. We also checked the Intel C compiler
     20(icc). Unfortunately, Visual C++ compiler knows not enough to compile the
     21library, so if you are using Microsoft Windows, then try to compile under
     22Cygwin.
     23
     24Ide kell írni:
     25 
     26-Hol fordul (Windows-os fordító nem fordítja, unix/linux alatt gcc hanyas verziója kell)
     27-
     28
     29In this description we will suppose a linux environment and Gnu C Compiler.
    1330
    1431\section downloadLEMON How to download LEMON
     
    1633You can download LEMON from the LEMON web site:
    1734http://lemon.cs.elte.hu
    18 by following the download link. There you will find the issued distributions in form of \e .ta.gz files. If you want a developer version  (for example you want to contribute in developing the library LEMON) then you might want to use our Subversion repository. This case is not detailed here, so from now on we suppose that you downloaded a tar.gz file.
     35by following the download link. There you will find the issued distributions
     36in form of <tt> .tar.gz </tt> files. If you want a developer version  (for example you want to contribute in developing the library LEMON) then you might want to use our Subversion repository. This case is not detailed here, so from now on we suppose that you downloaded a tar.gz file.
     37
    1938
    2039
     
    2342In order to install LEMON you have to do the following
    2443
    25 Download the tarball and issue the following commands:
     44Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x,\c y and \c z are
     45numbers indicating the version of the library: in our example we will have lemon-0.3.1) and issue the following commands:
    2646
    2747\code
     
    3454\endcode
    3555
    36 These commands install LEMON under /usr/local. If you want to install it to some other place, then pass the --prefix=DIR flag to ./configure.
     56These commands install LEMON under \c /usr/local (you will probably need \c root
     57privileges to be able to install to that directory). If you want to install it
     58to some other place, then pass the \c --prefix=DIR flag to \c ./configure. In
     59what follows we will assume that you were able to install to directory \c
     60/usr/local, otherwise some extra care is to be taken to use the library.
    3761
    38 Ide kell írni:
    39  
    40 -Hol fordul (Windows-os fordító nem fordítja, unix/linux alatt gcc hanyas verziója kell)
    41 -
     62We briefly explain these commands below.
     63
     64\code
     65tar xvzf lemon-0.3.1.tar.gz
     66\endcode
     67This command untars the <tt>tar.gz</tt> file into a directory named <tt> lemon-0.3.1</tt>.
     68
     69\code
     70cd lemon-0.3.1
     71\endcode
     72Enters the directory.
     73
     74\code
     75./configure
     76\endcode
     77Does some configuration (creates makefiles etc).
     78
     79\code
     80make
     81\endcode
     82This command compiles the <tt> .cc</tt> files of the library package (the
     83implementation of non-template functions and classes and some test and demo
     84programs) and creates the very important <b> libemon.la </b> file. When
     85linking your program that uses LEMON it needs to access this file.
     86
     87\code
     88make check (This is optional, but recomended. It runs a bunch of tests.)
     89\endcode
     90This is an optional step: it runs the test programs that we developed for
     91LEMON to check
     92whether the library works properly on your platform.
     93
     94\code
     95make install
     96\endcode
     97This will copy the directory structure to its final destination (e.g. to \c
     98/usr/local) so that your system can access it.
    4299
    43100\section helloworld My first program using LEMON
    44101
    45 If you have installed LEMON on your system you can paste the following code
     102If you have installed LEMON on your system you
     103can paste the following code
    46104segment into a file to have a first working program that uses library LEMON.
    47105
     
    55113{
    56114  typedef ListGraph Graph;
    57   typedef Graph::Edge Edge;
    58   typedef Graph::InEdgeIt InEdgeIt;
    59   typedef Graph::OutEdgeIt OutEdgeIt;
    60115  typedef Graph::EdgeIt EdgeIt;
    61   typedef Graph::Node Node;
    62116  typedef Graph::NodeIt NodeIt;
    63117
     
    83137\endcode
    84138
     139First let us briefly explain how this program works.
    85140
    86141ListGraph is one of LEMON's graph classes. It is based on linked lists,
     
    100155\c source member functions can be used to access the endpoints of an edge.
    101156
    102 The previous code fragment prints out the following:
     157If you have saved the preceding code into a file named, say,  \c hemon.cc and your installation of LEMON into directory \c /usr/local was
     158successful then it is very easy to compile this program with the following
     159command (the argument <tt>-lemon</tt> tells the compiler that we are using the
     160installed library LEMON):
     161\code
     162g++ hemon.cc -o hemon -lemon
     163\endcode
     164
     165As a result you will get the exacutable \c hemon in
     166this directory that you can run by the command
     167\code
     168./hemon
     169\endcode
     170
     171
     172If everything has gone well then the previous code fragment prints out the following:
    103173
    104174\code
     
    108178\endcode
    109179
     180Congratulations!
    110181
    111182If you want to see more features, go to the \ref quicktour "Quick Tour to
Note: See TracChangeset for help on using the changeset viewer.