doc/groups.dox
changeset 942 75fdd0c6866d
parent 814 d2d747fe1db3
child 947 93e9c45703ea
equal deleted inserted replaced
11:2bc042630891 12:2b1c7730c2d5
     1 
     1 
     2 /**
     2 /**
     3 @defgroup datas Data Structures
     3 @defgroup datas Data Structures
     4 This group describes the several graph structures implemented in HugoLib.
     4 This group describes the several graph structures implemented in LEMON.
     5 */
     5 */
     6 
     6 
     7 /**
     7 /**
     8 @defgroup graphs Graph Structures
     8 @defgroup graphs Graph Structures
     9 @ingroup datas
     9 @ingroup datas
    10 \brief Graph structures implemented in Hugo.
    10 \brief Graph structures implemented in LEMON.
    11 
    11 
    12 Hugolib provides several data structures to meet the diverging requirements
    12 LEMON provides several data structures to meet the diverging requirements
    13 of the possible users.
    13 of the possible users.
    14 In order to save on running time or on memory usage, some structures may
    14 In order to save on running time or on memory usage, some structures may
    15 fail to provide
    15 fail to provide
    16 some graph features like edge or node deletion.
    16 some graph features like edge or node deletion.
    17 
    17 
    18 Hugolib also offers special graphs that cannot be used alone but only
    18 LEMON also offers special graphs that cannot be used alone but only
    19 in conjunction with other graph representation. The examples for this are
    19 in conjunction with other graph representation. The examples for this are
    20 \ref hugo::EdgeSet "EdgeSet", \ref hugo::NodeSet "NodeSet"
    20 \ref lemon::EdgeSet "EdgeSet", \ref lemon::NodeSet "NodeSet"
    21 and the large variety of \ref gwrappers "graph wrappers".
    21 and the large variety of \ref gwrappers "graph wrappers".
    22 
    22 
    23 You are free to use the graph structure that fit your requirements
    23 You are free to use the graph structure that fit your requirements
    24 the best, most graph algorithms and auxiliary data structures can be used
    24 the best, most graph algorithms and auxiliary data structures can be used
    25 with any graph structures.
    25 with any graph structures.
    26 */
    26 */
    27 
    27 
    28 /**
    28 /**
    29 @defgroup auxdat Auxiliary Data Structures
    29 @defgroup auxdat Auxiliary Data Structures
    30 @ingroup datas
    30 @ingroup datas
    31 \brief Some data structures implemented in HugoLib.
    31 \brief Some data structures implemented in LEMON.
    32 
    32 
    33 This group describes the data structures implemented in HugoLib in
    33 This group describes the data structures implemented in LEMON in
    34 order to make it easier to implement combinatorial algorithms.
    34 order to make it easier to implement combinatorial algorithms.
    35 */
    35 */
    36 
    36 
    37 /**
    37 /**
    38 @defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
    38 @defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
    50 */
    50 */
    51 
    51 
    52 /**
    52 /**
    53 @defgroup galgs Graph Algorithms
    53 @defgroup galgs Graph Algorithms
    54 \brief This group describes the several graph algorithms
    54 \brief This group describes the several graph algorithms
    55 implemented in HugoLib.
    55 implemented in LEMON.
    56 */
    56 */
    57 
    57 
    58 /**
    58 /**
    59 @defgroup flowalgs Path and Flow Algorithms
    59 @defgroup flowalgs Path and Flow Algorithms
    60 @ingroup galgs
    60 @ingroup galgs
    70 
    70 
    71 /**
    71 /**
    72 @defgroup skeletons Skeletons
    72 @defgroup skeletons Skeletons
    73 \brief Skeletons (a.k.a. concept checking classes)
    73 \brief Skeletons (a.k.a. concept checking classes)
    74 
    74 
    75 This group describes the data/algorithm skeletons implemented in HugoLib in
    75 This group describes the data/algorithm skeletons implemented in LEMON in
    76 order to make it easier to check if a certain template class or
    76 order to make it easier to check if a certain template class or
    77 template function is correctly implemented.
    77 template function is correctly implemented.
    78 */
    78 */
    79 
    79 
    80 
    80