doc/groups.dox
author alpar
Tue, 20 Jul 2004 09:52:03 +0000
changeset 712 6f1abe741fb6
parent 492 d649b43e2dc0
child 758 49b1a30c4dc4
permissions -rw-r--r--
src/becnhmark gets in the distro.
I hope it works well.
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@678
    11
Hugolib provides several data structures to meet the diversing 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@678
    18
in conjunktion 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@678
    36
@defgroup gwrappers Wrapper Classes for Graphs
alpar@678
    37
\brief This group contains several wrapper classes for graphs
alpar@678
    38
@ingroup graphs
alpar@678
    39
*/
alpar@678
    40
alpar@678
    41
/**
alpar@678
    42
@defgroup galgs Graph Algorithms
alpar@678
    43
\brief This group describes the several graph algorithms
alpar@678
    44
implemented in HugoLib.
alpar@678
    45
*/
alpar@678
    46
alpar@678
    47
/**
alpar@678
    48
@defgroup spantree Minimum Cost Spanning Tree Algorithms
alpar@678
    49
\brief This group containes the algorithms for finding a minimum cost spanning
alpar@678
    50
tree in a graph
alpar@678
    51
@ingroup galgs
alpar@678
    52
*/
alpar@678
    53
alpar@678
    54
/**
alpar@678
    55
@defgroup misc Miscellaneous Tools
alpar@678
    56
Here you can find several useful tools for development,
alpar@678
    57
debugging and testing.
alpar@678
    58
*/
alpar@678
    59
alpar@678
    60
/**
alpar@678
    61
@defgroup experimental Experimental Structures and Algorithms
alpar@678
    62
This group contains some Experimental structures and algorithms.
alpar@678
    63
The stuff here is subject to change.
alpar@678
    64
*/
alpar@424
    65
alpar@424
    66
/// \ingroup misc experimental
alpar@424
    67
namespace hugo { }