doc/groups.dox
author deba
Fri, 14 Apr 2006 18:05:02 +0000
changeset 2050 d9a221218ea4
parent 2016 ecb067198349
child 2060 be70ea3b957a
permissions -rw-r--r--
Changing the mining of the clear in heaps
It does not touch the heap cross ref. It is
sometimes more clean useable and more efficient
     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 another 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 another algorithm, or a node-set 
    32 is to be shrunk for another algorithm. 
    33 LEMON also provides a variety of graphs for these requirements called 
    34 \ref graph_adaptors "graph adaptors". Adaptors 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 semi_adaptors Semi-Adaptors Classes for Graphs
    44 @ingroup graphs
    45 \brief Graph types between real graphs and graph adaptors.
    46 
    47 Graph types between real graphs and graph adaptors. These classes
    48 wrap graphs to give new functionality as the adaptors do it. But the
    49 other way they are not light-weigth structures as the adaptors.
    50 */
    51 
    52 /**
    53 @defgroup maps Maps 
    54 @ingroup datas
    55 \brief Some special purpose map to make life easier.
    56 
    57 LEMON provides several special maps that e.g. combine
    58 new maps from existing ones.
    59 */
    60 
    61 /**
    62 @defgroup graph_maps Graph Maps 
    63 @ingroup maps
    64 \brief Special Graph-Related Maps.
    65 
    66 These maps are specifically designed to assign values to the nodes and edges of
    67 graphs.
    68 */
    69 
    70 
    71 /**
    72 \defgroup map_adaptors Map Adaptors
    73 \ingroup maps
    74 \brief Tools to create new maps from existing ones
    75 
    76 Map adaptors are used to create "implicit" maps from other maps.
    77 
    78 Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
    79 make arithmetic oprerations between one or two maps (negation, scalig,
    80 addition, multiplication etc.) or e.g. convert a map to another one
    81 of different Value type.
    82 */
    83 
    84 /**
    85 @defgroup auxdat Auxiliary Data Structures
    86 @ingroup datas
    87 \brief Some data structures implemented in LEMON.
    88 
    89 This group describes the data structures implemented in LEMON in
    90 order to make it easier to implement combinatorial algorithms.
    91 */
    92 
    93 /**
    94 @defgroup graphbits Tools to Make It Easier to Make Graphs
    95 @ingroup auxdat
    96 \brief Tools to Make It Easier to Make Graphs.
    97 
    98 This group describes the tools that makes it easier to make graphs and
    99 the maps that dynamically update with the graph changes.
   100 */
   101 
   102 /**
   103 @defgroup galgs Graph Algorithms
   104 \brief This group describes the several graph algorithms
   105 implemented in LEMON.
   106 
   107 This group describes the several graph algorithms
   108 implemented in LEMON.
   109 */
   110 
   111 /**
   112 @defgroup gutils General Graph Utilities
   113 @ingroup galgs
   114 \brief This group describes some simple general graph utilities.
   115 
   116 This group describes some simple general graph utilities.
   117 */
   118 
   119 /**
   120 @defgroup gen_opt_group General Optimization Tools
   121 \brief This group describes some general optimization frameworks
   122 implemented in LEMON.
   123 
   124 \brief This group describes some general optimization frameworks
   125 implemented in LEMON.
   126 
   127 */
   128 
   129 /**
   130 @defgroup flowalgs Path and Flow Algorithms
   131 @ingroup galgs
   132 \brief This group describes the algorithms
   133 for finding paths and flows in graphs.
   134 */
   135 
   136 /**
   137 @defgroup topology Topology related algorithms
   138 @ingroup galgs
   139 \brief This group describes the algorithms
   140 for discover the topology of the graphs.
   141 */
   142 
   143 /**
   144 @defgroup matching Matching algorithms in graphs and bipartite graphs
   145 @ingroup galgs
   146 \brief This group describes the algorithms
   147 for find matchings in graphs and bipartite graphs.
   148 */
   149 
   150 /**
   151 @defgroup exceptions Exceptions
   152 This group contains the exceptions thrown by LEMON library
   153 */
   154 
   155 /**
   156 @defgroup misc Miscellaneous Tools
   157 Here you can find several useful tools for development,
   158 debugging and testing.
   159 */
   160 
   161 /**
   162 @defgroup timecount Time measuring and Counting
   163 @ingroup misc
   164 Here you can find simple tools for measuring the performance
   165 of algorithms.
   166 */
   167 
   168 /**
   169 @defgroup io_group Input-Output
   170 Here you can find tools for imporing and exporting graphs and graph related
   171 data
   172 */
   173 
   174 /**
   175 @defgroup section_io Section readers and writers
   176 @ingroup io_group
   177 \brief Section readers and writers for lemon Input-Output.
   178 
   179 Here you can find which section readers and writers can attach to
   180 the LemonReader and LemonWriter.
   181 */
   182 
   183 /**
   184 @defgroup item_io Item Readers and Writers
   185 @ingroup io_group
   186 \brief Item readers and writers for lemon Input-Output.
   187 
   188 The Input-Output classes can handle more data type by example
   189 as map or attribute value. Each of these should be written and
   190 read some way. The module make possible to do this.  
   191 */
   192 
   193 /**
   194 @defgroup concept Concepts
   195 \brief Skeleton classes and concept checking classes
   196 
   197 This group describes the data/algorithm skeletons and concept checking
   198 classes implemented in LEMON.
   199 
   200 One aim of these classes is to make it easier to check if a certain
   201 class or template function is correctly implemented.
   202 
   203 The other (sometimes even more important) aim is to document the concepts.
   204 
   205 */
   206 
   207 /**
   208 @defgroup graph_concepts Graph Structure Concepts
   209 @ingroup concept
   210 \brief Skeleton and concept checking classes for graph structures
   211 
   212 This group contains the skeletons and concept checking classes of LEMON's
   213 graph structures and helper classes used to implement these.
   214 */
   215 
   216 /* --- Unused group
   217 @defgroup experimental Experimental Structures and Algorithms
   218 This group contains some Experimental structures and algorithms.
   219 The stuff here is subject to change.
   220 */
   221 
   222 /**
   223 \anchor demoprograms
   224 
   225 @defgroup demos Demo programs
   226 
   227 Some demo programs are listed here. Their full source codes can be found in
   228 the \c demo subdirectory of the source tree.
   229 
   230 The standard compilation procedure (<tt>./configure;make</tt>) will compile
   231 them, as well. 
   232 
   233 */
   234