doc/groups.dox
author alpar
Sun, 14 Nov 2004 11:16:36 +0000
changeset 990 407e4d47fdd3
parent 947 93e9c45703ea
child 1030 c8a41699e613
permissions -rw-r--r--
An 'unused variable' warning when compiled with gcc-3.2.2 is removed
     1 
     2 /**
     3 @defgroup datas Data Structures
     4 This group describes the several graph structures implemented in LEMON.
     5 */
     6 
     7 /**
     8 @defgroup graphs Graph Structures
     9 @ingroup datas
    10 \brief Graph structures implemented in LEMON.
    11 
    12 LEMON provides several data structures to meet the diverging requirements
    13 of the possible users.
    14 In order to save on running time or on memory usage, some structures may
    15 fail to provide
    16 some graph features like edge or node deletion.
    17 
    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
    20 \ref lemon::EdgeSet "EdgeSet", \ref lemon::NodeSet "NodeSet"
    21 and the large variety of \ref gwrappers "graph wrappers".
    22 
    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
    25 with any graph structures.
    26 */
    27 
    28 /**
    29 @defgroup auxdat Auxiliary Data Structures
    30 @ingroup datas
    31 \brief Some data structures implemented in LEMON.
    32 
    33 This group describes the data structures implemented in LEMON in
    34 order to make it easier to implement combinatorial algorithms.
    35 */
    36 
    37 /**
    38 @defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
    39 @ingroup auxdat
    40 \brief Tools to Make It Easier to Make Graph Maps.
    41 
    42 This group describes the tools that makes it easier to make graph maps that
    43 dynamically update with the graph changes.
    44 */
    45 
    46 /**
    47 @defgroup gwrappers Wrapper Classes for Graphs
    48 \brief This group contains several wrapper classes for graphs
    49 @ingroup graphs
    50 */
    51 
    52 /**
    53 @defgroup galgs Graph Algorithms
    54 \brief This group describes the several graph algorithms
    55 implemented in LEMON.
    56 
    57 This group describes the several graph algorithms
    58 implemented in LEMON.
    59 */
    60 
    61 /**
    62 @defgroup gutils General Graph Utilities
    63 \brief This group describes some simple general graph utilities.
    64 @ingroup galgs
    65 
    66 This group describes some simple general graph utilities.
    67 */
    68 
    69 /**
    70 @defgroup flowalgs Path and Flow Algorithms
    71 @ingroup galgs
    72 \brief This group describes the algorithms
    73 for finding paths and flows in graphs.
    74 */
    75 
    76 /**
    77 @defgroup misc Miscellaneous Tools
    78 Here you can find several useful tools for development,
    79 debugging and testing.
    80 */
    81 
    82 /**
    83 @defgroup concept Concept
    84 \brief Skeleton classes and concept checking classes
    85 
    86 This group describes the data/algorithm skeletons and concept checking
    87 classes implemented in LEMON. These classes exist in order to make it
    88 easier to check if a certain template class or template function is
    89 correctly implemented.
    90 */
    91 
    92 
    93 /**
    94 @defgroup experimental Experimental Structures and Algorithms
    95 This group contains some Experimental structures and algorithms.
    96 The stuff here is subject to change.
    97 */