doc/groups.dox
author hegyi
Wed, 27 Jul 2005 11:19:35 +0000
changeset 1596 44897b1ba4e2
parent 1582 5fd89def7cbc
child 1639 aec340db8fc2
permissions -rw-r--r--
Sorry for the previous commit, it was not ready yet, but that damned up arrow... So in this new revision string-double and double-string conversion is corrected to a more C++ way.
     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 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 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 /**
    53 @defgroup graph_maps Graph Maps 
    54 @ingroup maps
    55 \brief Special Graph-Related Maps.
    56 
    57 These maps are specifically designed to assign values to the nodes and edges of
    58 graphs.
    59 */
    60 
    61 
    62 /**
    63 \defgroup map_adaptors Map Adaptors
    64 \ingroup maps
    65 \brief Tools to create new maps from existing ones
    66 
    67 Map adaptors are used to create "implicit" maps from other maps.
    68 
    69 Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
    70 make arithmetic oprerations between one or two maps (negation, scalig,
    71 addition, multiplication etc.) or e.g. convert a map to another one
    72 of different Value type.
    73 */
    74 
    75 /**
    76 @defgroup auxdat Auxiliary Data Structures
    77 @ingroup datas
    78 \brief Some data structures implemented in LEMON.
    79 
    80 This group describes the data structures implemented in LEMON in
    81 order to make it easier to implement combinatorial algorithms.
    82 */
    83 
    84 /**
    85 @defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
    86 @ingroup auxdat
    87 \brief Tools to Make It Easier to Make Graph Maps.
    88 
    89 This group describes the tools that makes it easier to make graph maps that
    90 dynamically update with the graph changes.
    91 */
    92 
    93 /**
    94 @defgroup galgs Graph Algorithms
    95 \brief This group describes the several graph algorithms
    96 implemented in LEMON.
    97 
    98 This group describes the several graph algorithms
    99 implemented in LEMON.
   100 */
   101 
   102 /**
   103 @defgroup gutils General Graph Utilities
   104 \brief This group describes some simple general graph utilities.
   105 @ingroup galgs
   106 
   107 This group describes some simple general graph utilities.
   108 */
   109 
   110 /**
   111 @defgroup gen_opt_group General Optimization Tools
   112 \brief This group describes some general optimization frameworks
   113 implemented in LEMON.
   114 
   115 \brief This group describes some general optimization frameworks
   116 implemented in LEMON.
   117 
   118 */
   119 
   120 /**
   121 @defgroup flowalgs Path and Flow Algorithms
   122 @ingroup galgs
   123 \brief This group describes the algorithms
   124 for finding paths and flows in graphs.
   125 */
   126 
   127 /**
   128 @defgroup exceptions Exceptions
   129 This group contains the exceptions thrown by LEMON library
   130 */
   131 
   132 /**
   133 @defgroup misc Miscellaneous Tools
   134 Here you can find several useful tools for development,
   135 debugging and testing.
   136 */
   137 
   138 /**
   139 @defgroup io_group Input Output
   140 Here you can find tools for imporing and exporting graphs and graph related
   141 data
   142 */
   143 
   144 /**
   145 @defgroup concept Concepts
   146 \brief Skeleton classes and concept checking classes
   147 
   148 This group describes the data/algorithm skeletons and concept checking
   149 classes implemented in LEMON.
   150 
   151 One aim of these classes is to make it easier to check if a certain
   152 class or template function is correctly implemented.
   153 
   154 The other (sometimes even more important) aim is to document the concepts.
   155 
   156 */
   157 
   158 /**
   159 @defgroup graph_concepts Graph Structure Concepts
   160 @ingroup concept
   161 \brief Skeleton and concept checking classes for graph structures
   162 
   163 This group contains the skeletons and concept checking classes of LEMON's
   164 graph structures and helper classes used to implement these.
   165 */
   166 
   167 /* --- Unused group
   168 @defgroup experimental Experimental Structures and Algorithms
   169 This group contains some Experimental structures and algorithms.
   170 The stuff here is subject to change.
   171 */
   172 
   173 /**
   174 \anchor demoprograms
   175 
   176 @defgroup demos Demo programs
   177 
   178 Some demo programs are listed here. Their full source codes can be found in
   179 the \c demo subdirectory of the source tree.
   180 
   181 The standard compilation procedure (<tt>./compile;make</tt>) will compile them,
   182 as well. 
   183 
   184 */
   185