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