doc/groups.dox
author deba
Sat, 09 Apr 2005 19:35:33 +0000
changeset 1333 2640cf6547ff
parent 1287 984723507b86
child 1401 9588dcef6793
permissions -rw-r--r--
Functionality changed:
The first map is the id map => The map named "id" is the id map

Documentation improvments
alpar@814
     1
alpar@678
     2
/**
alpar@678
     3
@defgroup datas Data Structures
alpar@921
     4
This group describes the several graph structures implemented in LEMON.
alpar@678
     5
*/
alpar@430
     6
alpar@678
     7
/**
alpar@678
     8
@defgroup graphs Graph Structures
alpar@678
     9
@ingroup datas
alpar@921
    10
\brief Graph structures implemented in LEMON.
alpar@430
    11
marci@1172
    12
The implementation of combinatorial algorithms heavily relies on 
marci@1172
    13
efficient graph implementations. LEMON offers data structures which are 
marci@1172
    14
planned to be easily used in an experimental phase of implementation studies, 
marci@1172
    15
and thereafter the program code can be made efficient by small modifications. 
alpar@430
    16
marci@1172
    17
The most efficient implementation of diverse applications require the usage of different physical graph implementations. These differences appear in the size of 
marci@1172
    18
graph we require to handle, memory or time usage limitations or in 
marci@1172
    19
the set of operations through which the graph can be accessed. 
marci@1172
    20
LEMON provides several physical graph structures to meet the 
marci@1172
    21
diverging requirements of the possible users. 
marci@1172
    22
In order to save on running time or on memory usage, some structures may 
marci@1172
    23
fail to provide some graph features like edge or node deletion.
marci@1172
    24
marci@1172
    25
Alteration of standard containers need a very limited number of 
marci@1172
    26
operations, these together satisfy the everyday requirements. 
marci@1172
    27
In the case of graph strutures, different operations are needed which do 
marci@1172
    28
not alter the physical graph, but gives an other view. If some nodes or 
marci@1172
    29
edges have to be hidden or the reverse oriented graph have to be used, then 
marci@1172
    30
this is the case. It also may happen that in a flow implemenation 
marci@1172
    31
the residual graph can be accessed by an other algorithm, or a node-set 
marci@1172
    32
is to be shrunk for an other algorithm. 
marci@1172
    33
LEMON also provides a variety of graphs for these requirements called 
marci@1172
    34
\ref gwrappers "graph wrappers". Wrappers cannot be used alone but only 
marci@1172
    35
in conjunction with other graph representation. 
alpar@430
    36
alpar@678
    37
You are free to use the graph structure that fit your requirements
alpar@678
    38
the best, most graph algorithms and auxiliary data structures can be used
marci@1172
    39
with any graph structures. 
alpar@678
    40
*/
alpar@430
    41
alpar@678
    42
/**
alpar@1043
    43
@defgroup maps Maps 
alpar@1043
    44
@ingroup datas
alpar@1043
    45
\brief Some special purpose map to make life easier.
alpar@1043
    46
alpar@1043
    47
LEMON provides several special maps that e.g. combine
alpar@1043
    48
new maps from existing ones.
alpar@1043
    49
*/
alpar@1043
    50
alpar@1043
    51
/**
alpar@678
    52
@defgroup auxdat Auxiliary Data Structures
alpar@678
    53
@ingroup datas
alpar@921
    54
\brief Some data structures implemented in LEMON.
alpar@406
    55
alpar@921
    56
This group describes the data structures implemented in LEMON in
alpar@678
    57
order to make it easier to implement combinatorial algorithms.
alpar@678
    58
*/
alpar@406
    59
alpar@678
    60
/**
alpar@785
    61
@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
alpar@785
    62
@ingroup auxdat
alpar@785
    63
\brief Tools to Make It Easier to Make Graph Maps.
alpar@785
    64
alpar@785
    65
This group describes the tools that makes it easier to make graph maps that
alpar@785
    66
dynamically update with the graph changes.
alpar@785
    67
*/
alpar@785
    68
alpar@785
    69
/**
alpar@678
    70
@defgroup galgs Graph Algorithms
alpar@678
    71
\brief This group describes the several graph algorithms
alpar@921
    72
implemented in LEMON.
alpar@947
    73
alpar@947
    74
This group describes the several graph algorithms
alpar@947
    75
implemented in LEMON.
alpar@947
    76
*/
alpar@947
    77
alpar@947
    78
/**
alpar@947
    79
@defgroup gutils General Graph Utilities
alpar@947
    80
\brief This group describes some simple general graph utilities.
alpar@947
    81
@ingroup galgs
alpar@947
    82
alpar@947
    83
This group describes some simple general graph utilities.
alpar@678
    84
*/
alpar@678
    85
alpar@678
    86
/**
alpar@1329
    87
@defgroup gen_opt_group General Optimization Tools
alpar@1329
    88
\brief This group describes some general optimization frameworks
alpar@1329
    89
implemented in LEMON.
alpar@1329
    90
alpar@1329
    91
\brief This group describes some general optimization frameworks
alpar@1329
    92
implemented in LEMON.
alpar@1329
    93
alpar@1329
    94
*/
alpar@1329
    95
alpar@1329
    96
/**
alpar@758
    97
@defgroup flowalgs Path and Flow Algorithms
alpar@678
    98
@ingroup galgs
alpar@758
    99
\brief This group describes the algorithms
alpar@758
   100
for finding paths and flows in graphs.
alpar@678
   101
*/
alpar@678
   102
alpar@678
   103
/**
alpar@1151
   104
@defgroup exceptions Exceptions
alpar@1151
   105
This group contains the exceptions thrown by LEMON library
alpar@1151
   106
*/
alpar@1151
   107
alpar@1151
   108
/**
alpar@678
   109
@defgroup misc Miscellaneous Tools
alpar@678
   110
Here you can find several useful tools for development,
alpar@678
   111
debugging and testing.
alpar@678
   112
*/
alpar@678
   113
alpar@678
   114
/**
alpar@1287
   115
@defgroup io_group Input Output
alpar@1287
   116
Here you can find tools for imporing and exporting graphs and graph related
alpar@1287
   117
data
alpar@1287
   118
*/
alpar@1287
   119
alpar@1287
   120
/**
klao@1030
   121
@defgroup concept Concepts
klao@959
   122
\brief Skeleton classes and concept checking classes
alpar@794
   123
klao@959
   124
This group describes the data/algorithm skeletons and concept checking
klao@1030
   125
classes implemented in LEMON.
klao@1030
   126
klao@1030
   127
One aim of these classes is to make it easier to check if a certain
klao@1030
   128
class or template function is correctly implemented.
klao@1030
   129
klao@1030
   130
The other (sometimes even more important) aim is to document the concepts.
klao@1030
   131
alpar@794
   132
*/
alpar@794
   133
klao@1030
   134
/**
klao@1030
   135
@defgroup graph_concepts Graph Structure Concepts
klao@1030
   136
@ingroup concept
klao@1030
   137
\brief Skeleton and concept checking classes for graph structures
klao@1030
   138
klao@1030
   139
This group contains the skeletons and concept checking classes of LEMON's
klao@1030
   140
graph structures and helper classes used to implement these.
klao@1030
   141
*/
alpar@794
   142
alpar@794
   143
/**
alpar@678
   144
@defgroup experimental Experimental Structures and Algorithms
alpar@678
   145
This group contains some Experimental structures and algorithms.
alpar@678
   146
The stuff here is subject to change.
alpar@678
   147
*/
alpar@1151
   148