doc/groups.dox
author deba
Thu, 02 Sep 2004 10:07:30 +0000
changeset 782 df2e45e09652
parent 758 49b1a30c4dc4
child 785 a9b0863c2265
permissions -rw-r--r--
--This line, and those below, will be ignored--

A hugo/sym_map_factory.h
M hugo/list_graph.h
A hugo/array_map_factory.h
A hugo/map_registry.h
M hugo/smart_graph.h
A hugo/map_defines.h
A hugo/extended_pair.h
M hugo/full_graph.h
A hugo/vector_map_factory.h
     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 gwrappers Wrapper Classes for Graphs
    37 \brief This group contains several wrapper classes for graphs
    38 @ingroup graphs
    39 */
    40 
    41 /**
    42 @defgroup galgs Graph Algorithms
    43 \brief This group describes the several graph algorithms
    44 implemented in HugoLib.
    45 */
    46 
    47 /**
    48 @defgroup flowalgs Path and Flow Algorithms
    49 @ingroup galgs
    50 \brief This group describes the algorithms
    51 for finding paths and flows in graphs.
    52 */
    53 
    54 /**
    55 @defgroup misc Miscellaneous Tools
    56 Here you can find several useful tools for development,
    57 debugging and testing.
    58 */
    59 
    60 /**
    61 @defgroup experimental Experimental Structures and Algorithms
    62 This group contains some Experimental structures and algorithms.
    63 The stuff here is subject to change.
    64 */
    65 
    66 /// \ingroup misc experimental
    67 namespace hugo { }