doc/groups.dox
changeset 720 193d881b23ad
parent 492 d649b43e2dc0
child 758 49b1a30c4dc4
equal deleted inserted replaced
5:53f099bf7b40 6:6b9b97effb86
     1 /// @defgroup datas Data Structures
     1 /**
     2 /// This group describes the several graph structures implemented in HugoLib.
     2 @defgroup datas Data Structures
       
     3 This group describes the several graph structures implemented in HugoLib.
       
     4 */
     3 
     5 
     4 /// @defgroup graphs Graph Structures
     6 /**
     5 /// @ingroup datas
     7 @defgroup graphs Graph Structures
     6 /// This group describes the graph structures implemented in HugoLib.
     8 @ingroup datas
       
     9 \brief Graph structures implemented in Hugo.
     7 
    10 
     8 /// @defgroup auxdat Auxiliary Data Structures
    11 Hugolib provides several data structures to meet the diversing requirements
     9 /// @ingroup datas
    12 of the possible users.
    10 /// This group describes the data structures implemented in HugoLib in
    13 In order to save on running time or on memory usage, some structures may
    11 /// order to make it easier to implement combinatorial algorithms.
    14 fail to provide
       
    15 some graph features like edge or node deletion.
    12 
    16 
    13 /// @defgroup gwrappers Wrapper Classes for Graphs
    17 Hugolib also offers special graphs that cannot be used alone but only
    14 /// @ingroup graphs
    18 in conjunktion with other graph representation. The examples for this are
    15 /// This group contains several wrapper classes for graphs
    19 \ref EdgeSet, \ref NodeSet, and the large variety of graph wrappers.
    16 
    20 
    17 /// @defgroup galgs Graph Algorithms
    21 You are free to use the graph structure that fit your requirements
    18 /// This group describes the several graph algorithms implemented in HugoLib.
    22 the best, most graph algorithms and auxiliary data structures can be used
       
    23 with any graph structures.
       
    24 */
    19 
    25 
    20 /// @defgroup misc Miscellaneous Tools
    26 /**
    21 /// Here you can find several useful tools for development,
    27 @defgroup auxdat Auxiliary Data Structures
    22 /// debugging and testing.
    28 @ingroup datas
       
    29 \brief Some data structures implemented in HugoLib.
    23 
    30 
    24 /// @defgroup experimental Experimental Structures and Algorithms
    31 This group describes the data structures implemented in HugoLib in
    25 /// This group contains some Experimental structures and algorithms.
    32 order to make it easier to implement combinatorial algorithms.
    26 /// The stuff here is subject to change.
    33 */
    27 
    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 spantree Minimum Cost Spanning Tree Algorithms
       
    49 \brief This group containes the algorithms for finding a minimum cost spanning
       
    50 tree in a graph
       
    51 @ingroup galgs
       
    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 */
    28 
    65 
    29 /// \ingroup misc experimental
    66 /// \ingroup misc experimental
    30 namespace hugo { }
    67 namespace hugo { }