gravatar
alpar (Alpar Juttner)
alpar@cs.elte.hu
Merge from trunk
0 4 0
merge 1.0
1 file changed with 22 insertions and 32 deletions:
↑ Collapse diff ↑
Show white space 16 line context
... ...
@@ -16,18 +16,18 @@
16 16
   2. `./configure'
17 17

	
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.
32 32

	
33 33
   5. `make install'
... ...
@@ -48,18 +48,18 @@
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'
64 64

	
65 65
  Pass the 'flags' to the compiler. For example CXXFLAGS='-O3 -march=pentium-m'
... ...
@@ -72,24 +72,16 @@
72 72
--enable-demo
73 73

	
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

	
94 86
   Do not build the programs in the tools subdirectory.
95 87

	
Show white space 16 line context
... ...
@@ -30,13 +30,13 @@
30 30
   Documentation of LEMON. The starting page is doc/html/index.html.
31 31

	
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
   Contains programs to check the integrity and correctness of LEMON.
38
   Programs to check the integrity and correctness of LEMON.
39 39

	
40 40
tools/
41 41

	
42 42
   Various utilities related to LEMON.
Show white space 16 line context
... ...
@@ -13,67 +13,65 @@
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
/**
20 20
\dir demo
21
\brief A collection of demo application.
21
\brief A collection of demo applications.
22 22

	
23
This directory contains several simple demo application, mainly
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
Auxiliary (and the whole generated) documentation.
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 lemon includes, so each include file must be
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 Implementation helper files
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
files.
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
*/
Show white space 16 line context
... ...
@@ -130,17 +130,17 @@
130 130
the two maps which can be done implicitly with the \c DivMap template
131 131
class. We use the implicit minimum time map as the length map of the
132 132
\c Dijkstra algorithm.
133 133
*/
134 134

	
135 135
/**
136 136
@defgroup paths Path Structures
137 137
@ingroup datas
138
\brief Path structures implemented in LEMON.
138
\brief %Path structures implemented in LEMON.
139 139

	
140 140
This group describes the path structures implemented in LEMON.
141 141

	
142 142
LEMON provides flexible data structures to work with paths.
143 143
All of them have similar interfaces and they can be copied easily with
144 144
assignment operators and copy constructors. This makes it easy and
145 145
efficient to have e.g. the Dijkstra algorithm to store its result in
146 146
any kind of path structure.
... ...
@@ -265,22 +265,22 @@
265 265
@defgroup concept Concepts
266 266
\brief Skeleton classes and concept checking classes
267 267

	
268 268
This group describes the data/algorithm skeletons and concept checking
269 269
classes implemented in LEMON.
270 270

	
271 271
The purpose of the classes in this group is fourfold.
272 272

	
273
- These classes contain the documentations of the concepts. In order
273
- These classes contain the documentations of the %concepts. In order
274 274
  to avoid document multiplications, an implementation of a concept
275 275
  simply refers to the corresponding concept class.
276 276

	
277 277
- These classes declare every functions, <tt>typedef</tt>s etc. an
278
  implementation of the concepts should provide, however completely
278
  implementation of the %concepts should provide, however completely
279 279
  without implementations and real data structures behind the
280 280
  interface. On the other hand they should provide nothing else. All
281 281
  the algorithms working on a data structure meeting a certain concept
282 282
  should compile with these classes. (Though it will not run properly,
283 283
  of course.) In this way it is easily to check if an algorithm
284 284
  doesn't use any extra feature of a certain implementation.
285 285

	
286 286
- The concept descriptor classes also provide a <em>checker class</em>
0 comments (0 inline)