doc/groups.dox
author alpar
Tue, 07 Sep 2004 07:09:53 +0000
changeset 812 182d3a4d7ddb
parent 785 a9b0863c2265
child 814 d2d747fe1db3
permissions -rw-r--r--
Spell checking.
alpar@678
     1
/**
alpar@678
     2
@defgroup datas Data Structures
alpar@678
     3
This group describes the several graph structures implemented in HugoLib.
alpar@678
     4
*/
alpar@430
     5
alpar@678
     6
/**
alpar@678
     7
@defgroup graphs Graph Structures
alpar@678
     8
@ingroup datas
alpar@678
     9
\brief Graph structures implemented in Hugo.
alpar@430
    10
alpar@774
    11
Hugolib provides several data structures to meet the diverging requirements
alpar@678
    12
of the possible users.
alpar@678
    13
In order to save on running time or on memory usage, some structures may
alpar@678
    14
fail to provide
alpar@678
    15
some graph features like edge or node deletion.
alpar@430
    16
alpar@678
    17
Hugolib also offers special graphs that cannot be used alone but only
alpar@774
    18
in conjunction with other graph representation. The examples for this are
alpar@678
    19
\ref EdgeSet, \ref NodeSet, and the large variety of graph wrappers.
alpar@430
    20
alpar@678
    21
You are free to use the graph structure that fit your requirements
alpar@678
    22
the best, most graph algorithms and auxiliary data structures can be used
alpar@678
    23
with any graph structures.
alpar@678
    24
*/
alpar@430
    25
alpar@678
    26
/**
alpar@678
    27
@defgroup auxdat Auxiliary Data Structures
alpar@678
    28
@ingroup datas
alpar@678
    29
\brief Some data structures implemented in HugoLib.
alpar@406
    30
alpar@678
    31
This group describes the data structures implemented in HugoLib in
alpar@678
    32
order to make it easier to implement combinatorial algorithms.
alpar@678
    33
*/
alpar@406
    34
alpar@678
    35
/**
alpar@785
    36
@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
alpar@785
    37
@ingroup auxdat
alpar@785
    38
\brief Tools to Make It Easier to Make Graph Maps.
alpar@785
    39
alpar@785
    40
This group describes the tools that makes it easier to make graph maps that
alpar@785
    41
dynamically update with the graph changes.
alpar@785
    42
*/
alpar@785
    43
alpar@785
    44
/**
alpar@678
    45
@defgroup gwrappers Wrapper Classes for Graphs
alpar@678
    46
\brief This group contains several wrapper classes for graphs
alpar@678
    47
@ingroup graphs
alpar@678
    48
*/
alpar@678
    49
alpar@678
    50
/**
alpar@678
    51
@defgroup galgs Graph Algorithms
alpar@678
    52
\brief This group describes the several graph algorithms
alpar@678
    53
implemented in HugoLib.
alpar@678
    54
*/
alpar@678
    55
alpar@678
    56
/**
alpar@758
    57
@defgroup flowalgs Path and Flow Algorithms
alpar@678
    58
@ingroup galgs
alpar@758
    59
\brief This group describes the algorithms
alpar@758
    60
for finding paths and flows in graphs.
alpar@678
    61
*/
alpar@678
    62
alpar@678
    63
/**
alpar@678
    64
@defgroup misc Miscellaneous Tools
alpar@678
    65
Here you can find several useful tools for development,
alpar@678
    66
debugging and testing.
alpar@678
    67
*/
alpar@678
    68
alpar@678
    69
/**
alpar@794
    70
@defgroup skeletons Skeletons
alpar@794
    71
\brief Skeletons (a.k.a. concept checking classes)
alpar@794
    72
alpar@794
    73
This group describes the data/algorithm skeletons implemented in HugoLib in
alpar@794
    74
order to make it easier to check if a certain template class or
alpar@794
    75
template function is correctly implemented.
alpar@794
    76
*/
alpar@794
    77
alpar@794
    78
alpar@794
    79
/**
alpar@678
    80
@defgroup experimental Experimental Structures and Algorithms
alpar@678
    81
This group contains some Experimental structures and algorithms.
alpar@678
    82
The stuff here is subject to change.
alpar@678
    83
*/
alpar@424
    84
alpar@424
    85
/// \ingroup misc experimental
alpar@424
    86
namespace hugo { }