doc/groups.dox
author ladanyi
Wed, 17 Nov 2004 08:46:07 +0000
changeset 999 5c846ec3f787
parent 947 93e9c45703ea
child 1030 c8a41699e613
permissions -rw-r--r--
Added a second SimAnn with the other controller.
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@678
    29
@defgroup auxdat Auxiliary Data Structures
alpar@678
    30
@ingroup datas
alpar@921
    31
\brief Some data structures implemented in LEMON.
alpar@406
    32
alpar@921
    33
This group describes the data structures implemented in LEMON in
alpar@678
    34
order to make it easier to implement combinatorial algorithms.
alpar@678
    35
*/
alpar@406
    36
alpar@678
    37
/**
alpar@785
    38
@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
alpar@785
    39
@ingroup auxdat
alpar@785
    40
\brief Tools to Make It Easier to Make Graph Maps.
alpar@785
    41
alpar@785
    42
This group describes the tools that makes it easier to make graph maps that
alpar@785
    43
dynamically update with the graph changes.
alpar@785
    44
*/
alpar@785
    45
alpar@785
    46
/**
alpar@678
    47
@defgroup gwrappers Wrapper Classes for Graphs
alpar@678
    48
\brief This group contains several wrapper classes for graphs
alpar@678
    49
@ingroup graphs
alpar@678
    50
*/
alpar@678
    51
alpar@678
    52
/**
alpar@678
    53
@defgroup galgs Graph Algorithms
alpar@678
    54
\brief This group describes the several graph algorithms
alpar@921
    55
implemented in LEMON.
alpar@947
    56
alpar@947
    57
This group describes the several graph algorithms
alpar@947
    58
implemented in LEMON.
alpar@947
    59
*/
alpar@947
    60
alpar@947
    61
/**
alpar@947
    62
@defgroup gutils General Graph Utilities
alpar@947
    63
\brief This group describes some simple general graph utilities.
alpar@947
    64
@ingroup galgs
alpar@947
    65
alpar@947
    66
This group describes some simple general graph utilities.
alpar@678
    67
*/
alpar@678
    68
alpar@678
    69
/**
alpar@758
    70
@defgroup flowalgs Path and Flow Algorithms
alpar@678
    71
@ingroup galgs
alpar@758
    72
\brief This group describes the algorithms
alpar@758
    73
for finding paths and flows in graphs.
alpar@678
    74
*/
alpar@678
    75
alpar@678
    76
/**
alpar@678
    77
@defgroup misc Miscellaneous Tools
alpar@678
    78
Here you can find several useful tools for development,
alpar@678
    79
debugging and testing.
alpar@678
    80
*/
alpar@678
    81
alpar@678
    82
/**
klao@959
    83
@defgroup concept Concept
klao@959
    84
\brief Skeleton classes and concept checking classes
alpar@794
    85
klao@959
    86
This group describes the data/algorithm skeletons and concept checking
klao@959
    87
classes implemented in LEMON. These classes exist in order to make it
klao@959
    88
easier to check if a certain template class or template function is
klao@959
    89
correctly implemented.
alpar@794
    90
*/
alpar@794
    91
alpar@794
    92
alpar@794
    93
/**
alpar@678
    94
@defgroup experimental Experimental Structures and Algorithms
alpar@678
    95
This group contains some Experimental structures and algorithms.
alpar@678
    96
The stuff here is subject to change.
alpar@678
    97
*/