[814] | 1 | |
---|
[678] | 2 | /** |
---|
| 3 | @defgroup datas Data Structures |
---|
[921] | 4 | This group describes the several graph structures implemented in LEMON. |
---|
[678] | 5 | */ |
---|
[430] | 6 | |
---|
[678] | 7 | /** |
---|
| 8 | @defgroup graphs Graph Structures |
---|
| 9 | @ingroup datas |
---|
[921] | 10 | \brief Graph structures implemented in LEMON. |
---|
[430] | 11 | |
---|
[1172] | 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. |
---|
[430] | 16 | |
---|
[1172] | 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. |
---|
[430] | 36 | |
---|
[678] | 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 |
---|
[1172] | 39 | with any graph structures. |
---|
[678] | 40 | */ |
---|
[430] | 41 | |
---|
[678] | 42 | /** |
---|
[1043] | 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 | /** |
---|
[678] | 52 | @defgroup auxdat Auxiliary Data Structures |
---|
| 53 | @ingroup datas |
---|
[921] | 54 | \brief Some data structures implemented in LEMON. |
---|
[406] | 55 | |
---|
[921] | 56 | This group describes the data structures implemented in LEMON in |
---|
[678] | 57 | order to make it easier to implement combinatorial algorithms. |
---|
| 58 | */ |
---|
[406] | 59 | |
---|
[678] | 60 | /** |
---|
[785] | 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 | /** |
---|
[678] | 70 | @defgroup galgs Graph Algorithms |
---|
| 71 | \brief This group describes the several graph algorithms |
---|
[921] | 72 | implemented in LEMON. |
---|
[947] | 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. |
---|
[678] | 84 | */ |
---|
| 85 | |
---|
| 86 | /** |
---|
[758] | 87 | @defgroup flowalgs Path and Flow Algorithms |
---|
[678] | 88 | @ingroup galgs |
---|
[758] | 89 | \brief This group describes the algorithms |
---|
| 90 | for finding paths and flows in graphs. |
---|
[678] | 91 | */ |
---|
| 92 | |
---|
| 93 | /** |
---|
[1151] | 94 | @defgroup exceptions Exceptions |
---|
| 95 | This group contains the exceptions thrown by LEMON library |
---|
| 96 | */ |
---|
| 97 | |
---|
| 98 | /** |
---|
[678] | 99 | @defgroup misc Miscellaneous Tools |
---|
| 100 | Here you can find several useful tools for development, |
---|
| 101 | debugging and testing. |
---|
| 102 | */ |
---|
| 103 | |
---|
| 104 | /** |
---|
[1287] | 105 | @defgroup io_group Input Output |
---|
| 106 | Here you can find tools for imporing and exporting graphs and graph related |
---|
| 107 | data |
---|
| 108 | */ |
---|
| 109 | |
---|
| 110 | /** |
---|
[1030] | 111 | @defgroup concept Concepts |
---|
[959] | 112 | \brief Skeleton classes and concept checking classes |
---|
[794] | 113 | |
---|
[959] | 114 | This group describes the data/algorithm skeletons and concept checking |
---|
[1030] | 115 | classes implemented in LEMON. |
---|
| 116 | |
---|
| 117 | One aim of these classes is to make it easier to check if a certain |
---|
| 118 | class or template function is correctly implemented. |
---|
| 119 | |
---|
| 120 | The other (sometimes even more important) aim is to document the concepts. |
---|
| 121 | |
---|
[794] | 122 | */ |
---|
| 123 | |
---|
[1030] | 124 | /** |
---|
| 125 | @defgroup graph_concepts Graph Structure Concepts |
---|
| 126 | @ingroup concept |
---|
| 127 | \brief Skeleton and concept checking classes for graph structures |
---|
| 128 | |
---|
| 129 | This group contains the skeletons and concept checking classes of LEMON's |
---|
| 130 | graph structures and helper classes used to implement these. |
---|
| 131 | */ |
---|
[794] | 132 | |
---|
| 133 | /** |
---|
[678] | 134 | @defgroup experimental Experimental Structures and Algorithms |
---|
| 135 | This group contains some Experimental structures and algorithms. |
---|
| 136 | The stuff here is subject to change. |
---|
| 137 | */ |
---|
[1151] | 138 | |
---|