doc/groups.dox
author alpar
Fri, 18 Feb 2005 10:36:13 +0000
changeset 1154 f07c1c442e6c
parent 1043 52a2201a88e9
child 1172 37338ae42a2b
permissions -rw-r--r--
Description of the LEMON directories.
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
alpar@921
    12
LEMON provides several data structures to meet the diverging requirements
alpar@678
    13
of the possible users.
alpar@678
    14
In order to save on running time or on memory usage, some structures may
alpar@678
    15
fail to provide
alpar@678
    16
some graph features like edge or node deletion.
alpar@430
    17
alpar@921
    18
LEMON also offers special graphs that cannot be used alone but only
alpar@774
    19
in conjunction with other graph representation. The examples for this are
alpar@921
    20
\ref lemon::EdgeSet "EdgeSet", \ref lemon::NodeSet "NodeSet"
alpar@814
    21
and the large variety of \ref gwrappers "graph wrappers".
alpar@430
    22
alpar@678
    23
You are free to use the graph structure that fit your requirements
alpar@678
    24
the best, most graph algorithms and auxiliary data structures can be used
alpar@678
    25
with any graph structures.
alpar@678
    26
*/
alpar@430
    27
alpar@678
    28
/**
alpar@1043
    29
@defgroup maps Maps 
alpar@1043
    30
@ingroup datas
alpar@1043
    31
\brief Some special purpose map to make life easier.
alpar@1043
    32
alpar@1043
    33
LEMON provides several special maps that e.g. combine
alpar@1043
    34
new maps from existing ones.
alpar@1043
    35
*/
alpar@1043
    36
alpar@1043
    37
/**
alpar@678
    38
@defgroup auxdat Auxiliary Data Structures
alpar@678
    39
@ingroup datas
alpar@921
    40
\brief Some data structures implemented in LEMON.
alpar@406
    41
alpar@921
    42
This group describes the data structures implemented in LEMON in
alpar@678
    43
order to make it easier to implement combinatorial algorithms.
alpar@678
    44
*/
alpar@406
    45
alpar@678
    46
/**
alpar@785
    47
@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
alpar@785
    48
@ingroup auxdat
alpar@785
    49
\brief Tools to Make It Easier to Make Graph Maps.
alpar@785
    50
alpar@785
    51
This group describes the tools that makes it easier to make graph maps that
alpar@785
    52
dynamically update with the graph changes.
alpar@785
    53
*/
alpar@785
    54
alpar@785
    55
/**
alpar@678
    56
@defgroup gwrappers Wrapper Classes for Graphs
alpar@678
    57
\brief This group contains several wrapper classes for graphs
alpar@678
    58
@ingroup graphs
alpar@678
    59
*/
alpar@678
    60
alpar@678
    61
/**
alpar@678
    62
@defgroup galgs Graph Algorithms
alpar@678
    63
\brief This group describes the several graph algorithms
alpar@921
    64
implemented in LEMON.
alpar@947
    65
alpar@947
    66
This group describes the several graph algorithms
alpar@947
    67
implemented in LEMON.
alpar@947
    68
*/
alpar@947
    69
alpar@947
    70
/**
alpar@947
    71
@defgroup gutils General Graph Utilities
alpar@947
    72
\brief This group describes some simple general graph utilities.
alpar@947
    73
@ingroup galgs
alpar@947
    74
alpar@947
    75
This group describes some simple general graph utilities.
alpar@678
    76
*/
alpar@678
    77
alpar@678
    78
/**
alpar@758
    79
@defgroup flowalgs Path and Flow Algorithms
alpar@678
    80
@ingroup galgs
alpar@758
    81
\brief This group describes the algorithms
alpar@758
    82
for finding paths and flows in graphs.
alpar@678
    83
*/
alpar@678
    84
alpar@678
    85
/**
alpar@1151
    86
@defgroup exceptions Exceptions
alpar@1151
    87
This group contains the exceptions thrown by LEMON library
alpar@1151
    88
*/
alpar@1151
    89
alpar@1151
    90
/**
alpar@678
    91
@defgroup misc Miscellaneous Tools
alpar@678
    92
Here you can find several useful tools for development,
alpar@678
    93
debugging and testing.
alpar@678
    94
*/
alpar@678
    95
alpar@678
    96
/**
klao@1030
    97
@defgroup concept Concepts
klao@959
    98
\brief Skeleton classes and concept checking classes
alpar@794
    99
klao@959
   100
This group describes the data/algorithm skeletons and concept checking
klao@1030
   101
classes implemented in LEMON.
klao@1030
   102
klao@1030
   103
One aim of these classes is to make it easier to check if a certain
klao@1030
   104
class or template function is correctly implemented.
klao@1030
   105
klao@1030
   106
The other (sometimes even more important) aim is to document the concepts.
klao@1030
   107
alpar@794
   108
*/
alpar@794
   109
klao@1030
   110
/**
klao@1030
   111
@defgroup graph_concepts Graph Structure Concepts
klao@1030
   112
@ingroup concept
klao@1030
   113
\brief Skeleton and concept checking classes for graph structures
klao@1030
   114
klao@1030
   115
This group contains the skeletons and concept checking classes of LEMON's
klao@1030
   116
graph structures and helper classes used to implement these.
klao@1030
   117
*/
alpar@794
   118
alpar@794
   119
/**
alpar@678
   120
@defgroup experimental Experimental Structures and Algorithms
alpar@678
   121
This group contains some Experimental structures and algorithms.
alpar@678
   122
The stuff here is subject to change.
alpar@678
   123
*/
alpar@1151
   124