doc/groups.dox
author jacint
Tue, 29 Mar 2005 07:35:09 +0000
changeset 1270 806451fd084b
parent 1151 b217fc69f913
child 1287 984723507b86
permissions -rw-r--r--
bugfixes in doc
     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 The implementation of combinatorial algorithms heavily relies on 
    13 efficient graph implementations. LEMON offers data structures which are 
    14 planned to be easily used in an experimental phase of implementation studies, 
    15 and thereafter the program code can be made efficient by small modifications. 
    16 
    17 The most efficient implementation of diverse applications require the usage of different physical graph implementations. These differences appear in the size of 
    18 graph we require to handle, memory or time usage limitations or in 
    19 the set of operations through which the graph can be accessed. 
    20 LEMON provides several physical graph structures to meet the 
    21 diverging requirements of the possible users. 
    22 In order to save on running time or on memory usage, some structures may 
    23 fail to provide some graph features like edge or node deletion.
    24 
    25 Alteration of standard containers need a very limited number of 
    26 operations, these together satisfy the everyday requirements. 
    27 In the case of graph strutures, different operations are needed which do 
    28 not alter the physical graph, but gives an other view. If some nodes or 
    29 edges have to be hidden or the reverse oriented graph have to be used, then 
    30 this is the case. It also may happen that in a flow implemenation 
    31 the residual graph can be accessed by an other algorithm, or a node-set 
    32 is to be shrunk for an other algorithm. 
    33 LEMON also provides a variety of graphs for these requirements called 
    34 \ref gwrappers "graph wrappers". Wrappers cannot be used alone but only 
    35 in conjunction with other graph representation. 
    36 
    37 You are free to use the graph structure that fit your requirements
    38 the best, most graph algorithms and auxiliary data structures can be used
    39 with any graph structures. 
    40 */
    41 
    42 /**
    43 @defgroup maps Maps 
    44 @ingroup datas
    45 \brief Some special purpose map to make life easier.
    46 
    47 LEMON provides several special maps that e.g. combine
    48 new maps from existing ones.
    49 */
    50 
    51 /**
    52 @defgroup auxdat Auxiliary Data Structures
    53 @ingroup datas
    54 \brief Some data structures implemented in LEMON.
    55 
    56 This group describes the data structures implemented in LEMON in
    57 order to make it easier to implement combinatorial algorithms.
    58 */
    59 
    60 /**
    61 @defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
    62 @ingroup auxdat
    63 \brief Tools to Make It Easier to Make Graph Maps.
    64 
    65 This group describes the tools that makes it easier to make graph maps that
    66 dynamically update with the graph changes.
    67 */
    68 
    69 /**
    70 @defgroup galgs Graph Algorithms
    71 \brief This group describes the several graph algorithms
    72 implemented in LEMON.
    73 
    74 This group describes the several graph algorithms
    75 implemented in LEMON.
    76 */
    77 
    78 /**
    79 @defgroup gutils General Graph Utilities
    80 \brief This group describes some simple general graph utilities.
    81 @ingroup galgs
    82 
    83 This group describes some simple general graph utilities.
    84 */
    85 
    86 /**
    87 @defgroup flowalgs Path and Flow Algorithms
    88 @ingroup galgs
    89 \brief This group describes the algorithms
    90 for finding paths and flows in graphs.
    91 */
    92 
    93 /**
    94 @defgroup exceptions Exceptions
    95 This group contains the exceptions thrown by LEMON library
    96 */
    97 
    98 /**
    99 @defgroup misc Miscellaneous Tools
   100 Here you can find several useful tools for development,
   101 debugging and testing.
   102 */
   103 
   104 /**
   105 @defgroup concept Concepts
   106 \brief Skeleton classes and concept checking classes
   107 
   108 This group describes the data/algorithm skeletons and concept checking
   109 classes implemented in LEMON.
   110 
   111 One aim of these classes is to make it easier to check if a certain
   112 class or template function is correctly implemented.
   113 
   114 The other (sometimes even more important) aim is to document the concepts.
   115 
   116 */
   117 
   118 /**
   119 @defgroup graph_concepts Graph Structure Concepts
   120 @ingroup concept
   121 \brief Skeleton and concept checking classes for graph structures
   122 
   123 This group contains the skeletons and concept checking classes of LEMON's
   124 graph structures and helper classes used to implement these.
   125 */
   126 
   127 /**
   128 @defgroup experimental Experimental Structures and Algorithms
   129 This group contains some Experimental structures and algorithms.
   130 The stuff here is subject to change.
   131 */
   132