doc/groups.dox
author deba
Wed, 08 Sep 2004 12:06:45 +0000
changeset 822 88226d9fe821
parent 794 d9ec436d11fe
child 921 818510fa3d99
permissions -rw-r--r--
The MapFactories have been removed from the code because
if we use macros then they increases only the complexity.

The pair iterators of the maps are separeted from the maps.

Some macros and comments has been changed.
alpar@814
     1
alpar@678
     2
/**
alpar@678
     3
@defgroup datas Data Structures
alpar@678
     4
This group describes the several graph structures implemented in HugoLib.
alpar@678
     5
*/
alpar@430
     6
alpar@678
     7
/**
alpar@678
     8
@defgroup graphs Graph Structures
alpar@678
     9
@ingroup datas
alpar@678
    10
\brief Graph structures implemented in Hugo.
alpar@430
    11
alpar@774
    12
Hugolib 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@678
    18
Hugolib 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@814
    20
\ref hugo::EdgeSet "EdgeSet", \ref hugo::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@678
    31
\brief Some data structures implemented in HugoLib.
alpar@406
    32
alpar@678
    33
This group describes the data structures implemented in HugoLib 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@678
    55
implemented in HugoLib.
alpar@678
    56
*/
alpar@678
    57
alpar@678
    58
/**
alpar@758
    59
@defgroup flowalgs Path and Flow Algorithms
alpar@678
    60
@ingroup galgs
alpar@758
    61
\brief This group describes the algorithms
alpar@758
    62
for finding paths and flows in graphs.
alpar@678
    63
*/
alpar@678
    64
alpar@678
    65
/**
alpar@678
    66
@defgroup misc Miscellaneous Tools
alpar@678
    67
Here you can find several useful tools for development,
alpar@678
    68
debugging and testing.
alpar@678
    69
*/
alpar@678
    70
alpar@678
    71
/**
alpar@794
    72
@defgroup skeletons Skeletons
alpar@794
    73
\brief Skeletons (a.k.a. concept checking classes)
alpar@794
    74
alpar@794
    75
This group describes the data/algorithm skeletons implemented in HugoLib in
alpar@794
    76
order to make it easier to check if a certain template class or
alpar@794
    77
template function is correctly implemented.
alpar@794
    78
*/
alpar@794
    79
alpar@794
    80
alpar@794
    81
/**
alpar@678
    82
@defgroup experimental Experimental Structures and Algorithms
alpar@678
    83
This group contains some Experimental structures and algorithms.
alpar@678
    84
The stuff here is subject to change.
alpar@678
    85
*/