r318:1e2d6ca80793
Thu, 09 Oct 2008 22:41:29
[Not Reviewed]
0 comments (0 inline)
0
4
0
| 1 | 1 |
Installation Instructions |
| 2 | 2 |
========================= |
| 3 | 3 |
|
| 4 |
|
|
| 4 |
Since you are reading this I assume you already obtained one of the release |
|
| 5 | 5 |
tarballs and successfully extracted it. The latest version of LEMON is |
| 6 | 6 |
available at our web page (http://lemon.cs.elte.hu/). |
| 7 | 7 |
|
| 8 |
|
|
| 8 |
In order to install LEMON from the extracted source tarball you have to |
|
| 9 | 9 |
issue the following commands: |
| 10 | 10 |
|
| 11 | 11 |
1. `cd lemon-x.y.z' |
| 12 | 12 |
|
| 13 | 13 |
This command changes to the directory which was created when you |
| 14 | 14 |
extracted the sources. The x.y.z part is a version number. |
| ... | ... |
@@ -18,14 +18,14 @@ |
| 18 | 18 |
This command runs the configure shell script, which does some checks and |
| 19 | 19 |
creates the makefiles. |
| 20 | 20 |
|
| 21 | 21 |
3. `make' |
| 22 | 22 |
|
| 23 | 23 |
This command compiles the non-template part of LEMON into libemon.a |
| 24 |
file. It also compiles the programs in the tools, benchmark and demo |
|
| 25 |
subdirectories when enabled. |
|
| 24 |
file. It also compiles the programs in the tools and demo subdirectories |
|
| 25 |
when enabled. |
|
| 26 | 26 |
|
| 27 | 27 |
4. `make check' |
| 28 | 28 |
|
| 29 | 29 |
This step is optional, but recommended. It runs the test programs that |
| 30 | 30 |
we developed for LEMON to check whether the library works properly on |
| 31 | 31 |
your platform. |
| ... | ... |
@@ -46,18 +46,18 @@ |
| 46 | 46 |
Latex. |
| 47 | 47 |
|
| 48 | 48 |
|
| 49 | 49 |
Configure Options and Variables |
| 50 | 50 |
=============================== |
| 51 | 51 |
|
| 52 |
|
|
| 52 |
In step 2 you can customize the actions of configure by setting variables |
|
| 53 | 53 |
and passing options to it. This can be done like this: |
| 54 | 54 |
`./configure [OPTION]... [VARIABLE=VALUE]...' |
| 55 | 55 |
|
| 56 |
Below you will find some useful variables and options (see |
|
| 57 |
`./configure --help' for more): |
|
| 56 |
Below you will find some useful variables and options (see `./configure --help' |
|
| 57 |
for more): |
|
| 58 | 58 |
|
| 59 | 59 |
CXX='comp' |
| 60 | 60 |
|
| 61 | 61 |
Change the C++ compiler to 'comp'. |
| 62 | 62 |
|
| 63 | 63 |
CXXFLAGS='flags' |
| ... | ... |
@@ -74,20 +74,12 @@ |
| 74 | 74 |
Build the examples in the demo subdirectory. |
| 75 | 75 |
|
| 76 | 76 |
--disable-demo |
| 77 | 77 |
|
| 78 | 78 |
Do not build the examples in the demo subdirectory (default). |
| 79 | 79 |
|
| 80 |
--enable-benchmark |
|
| 81 |
|
|
| 82 |
Build the programs in the benchmark subdirectory. |
|
| 83 |
|
|
| 84 |
--disable-benchmark |
|
| 85 |
|
|
| 86 |
Do not build the programs in the benchmark subdirectory (default). |
|
| 87 |
|
|
| 88 | 80 |
--enable-tools |
| 89 | 81 |
|
| 90 | 82 |
Build the programs in the tools subdirectory (default). |
| 91 | 83 |
|
| 92 | 84 |
--disable-tools |
| 93 | 85 |
| ... | ... |
@@ -32,11 +32,11 @@ |
| 32 | 32 |
demo/ |
| 33 | 33 |
|
| 34 | 34 |
Some example programs to make you easier to get familiar with LEMON. |
| 35 | 35 |
|
| 36 | 36 |
test/ |
| 37 | 37 |
|
| 38 |
|
|
| 38 |
Programs to check the integrity and correctness of LEMON. |
|
| 39 | 39 |
|
| 40 | 40 |
tools/ |
| 41 | 41 |
|
| 42 | 42 |
Various utilities related to LEMON. |
| ... | ... |
@@ -15,65 +15,63 @@ |
| 15 | 15 |
* purpose. |
| 16 | 16 |
* |
| 17 | 17 |
*/ |
| 18 | 18 |
|
| 19 | 19 |
/** |
| 20 | 20 |
\dir demo |
| 21 |
\brief A collection of demo |
|
| 21 |
\brief A collection of demo applications. |
|
| 22 | 22 |
|
| 23 |
This directory contains several simple demo |
|
| 23 |
This directory contains several simple demo applications, mainly |
|
| 24 | 24 |
for educational purposes. |
| 25 | 25 |
*/ |
| 26 | 26 |
|
| 27 | 27 |
/** |
| 28 | 28 |
\dir doc |
| 29 | 29 |
\brief Auxiliary (and the whole generated) documentation. |
| 30 | 30 |
|
| 31 |
|
|
| 31 |
This directory contains some auxiliary pages and the whole generated |
|
| 32 |
documentation. |
|
| 32 | 33 |
*/ |
| 33 | 34 |
|
| 34 | 35 |
/** |
| 35 | 36 |
\dir test |
| 36 | 37 |
\brief Test programs. |
| 37 | 38 |
|
| 38 | 39 |
This directory contains several test programs that check the consistency |
| 39 | 40 |
of the code. |
| 40 | 41 |
*/ |
| 41 | 42 |
|
| 42 | 43 |
/** |
| 43 | 44 |
\dir tools |
| 44 |
\brief Some useful executables |
|
| 45 |
\brief Some useful executables. |
|
| 45 | 46 |
|
| 46 | 47 |
This directory contains the sources of some useful complete executables. |
| 47 |
|
|
| 48 | 48 |
*/ |
| 49 | 49 |
|
| 50 |
|
|
| 51 |
|
|
| 52 | 50 |
/** |
| 53 | 51 |
\dir lemon |
| 54 |
\brief Base include directory of LEMON |
|
| 52 |
\brief Base include directory of LEMON. |
|
| 55 | 53 |
|
| 56 |
This is the base directory of |
|
| 54 |
This is the base directory of LEMON includes, so each include file must be |
|
| 57 | 55 |
prefixed with this, e.g. |
| 58 | 56 |
\code |
| 59 | 57 |
#include<lemon/list_graph.h> |
| 60 | 58 |
#include<lemon/dijkstra.h> |
| 61 | 59 |
\endcode |
| 62 | 60 |
*/ |
| 63 | 61 |
|
| 64 | 62 |
/** |
| 65 | 63 |
\dir concepts |
| 66 |
\brief Concept descriptors and checking classes |
|
| 64 |
\brief Concept descriptors and checking classes. |
|
| 67 | 65 |
|
| 68 |
This directory contains the concept descriptors and concept checkers. As a user |
|
| 69 |
you typically don't have to deal with these files. |
|
| 66 |
This directory contains the concept descriptors and concept checking tools. |
|
| 67 |
For more information see the \ref concept "Concepts" module. |
|
| 70 | 68 |
*/ |
| 71 | 69 |
|
| 72 | 70 |
/** |
| 73 | 71 |
\dir bits |
| 74 |
\brief |
|
| 72 |
\brief Auxiliary tools for implementation. |
|
| 75 | 73 |
|
| 76 |
This directory contains some helper classes to implement graphs, maps and |
|
| 77 |
some other classes. As a user you typically don't have to deal with these |
|
| 78 |
|
|
| 74 |
This directory contains some auxiliary classes for implementing graphs, |
|
| 75 |
maps and some other classes. |
|
| 76 |
As a user you typically don't have to deal with these files. |
|
| 79 | 77 |
*/ |
| ... | ... |
@@ -162,13 +162,13 @@ |
| 162 | 162 |
This group describes two dimensional data storages implemented in LEMON. |
| 163 | 163 |
*/ |
| 164 | 164 |
|
| 165 | 165 |
/** |
| 166 | 166 |
@defgroup paths Path Structures |
| 167 | 167 |
@ingroup datas |
| 168 |
\brief Path structures implemented in LEMON. |
|
| 168 |
\brief %Path structures implemented in LEMON. |
|
| 169 | 169 |
|
| 170 | 170 |
This group describes the path structures implemented in LEMON. |
| 171 | 171 |
|
| 172 | 172 |
LEMON provides flexible data structures to work with paths. |
| 173 | 173 |
All of them have similar interfaces and they can be copied easily with |
| 174 | 174 |
assignment operators and copy constructors. This makes it easy and |
| ... | ... |
@@ -487,18 +487,18 @@ |
| 487 | 487 |
|
| 488 | 488 |
This group describes the data/algorithm skeletons and concept checking |
| 489 | 489 |
classes implemented in LEMON. |
| 490 | 490 |
|
| 491 | 491 |
The purpose of the classes in this group is fourfold. |
| 492 | 492 |
|
| 493 |
- These classes contain the documentations of the concepts. In order |
|
| 493 |
- These classes contain the documentations of the %concepts. In order |
|
| 494 | 494 |
to avoid document multiplications, an implementation of a concept |
| 495 | 495 |
simply refers to the corresponding concept class. |
| 496 | 496 |
|
| 497 | 497 |
- These classes declare every functions, <tt>typedef</tt>s etc. an |
| 498 |
implementation of the concepts should provide, however completely |
|
| 498 |
implementation of the %concepts should provide, however completely |
|
| 499 | 499 |
without implementations and real data structures behind the |
| 500 | 500 |
interface. On the other hand they should provide nothing else. All |
| 501 | 501 |
the algorithms working on a data structure meeting a certain concept |
| 502 | 502 |
should compile with these classes. (Though it will not run properly, |
| 503 | 503 |
of course.) In this way it is easily to check if an algorithm |
| 504 | 504 |
doesn't use any extra feature of a certain implementation. |
0 comments (0 inline)