1.1 --- a/doc/groups.dox Mon May 15 09:46:33 2006 +0000
1.2 +++ b/doc/groups.dox Mon May 15 09:49:51 2006 +0000
1.3 @@ -14,13 +14,14 @@
1.4 planned to be easily used in an experimental phase of implementation studies,
1.5 and thereafter the program code can be made efficient by small modifications.
1.6
1.7 -The most efficient implementation of diverse applications require the usage of different physical graph implementations. These differences appear in the size of
1.8 -graph we require to handle, memory or time usage limitations or in
1.9 -the set of operations through which the graph can be accessed.
1.10 -LEMON provides several physical graph structures to meet the
1.11 -diverging requirements of the possible users.
1.12 -In order to save on running time or on memory usage, some structures may
1.13 -fail to provide some graph features like edge or node deletion.
1.14 +The most efficient implementation of diverse applications require the
1.15 +usage of different physical graph implementations. These differences
1.16 +appear in the size of graph we require to handle, memory or time usage
1.17 +limitations or in the set of operations through which the graph can be
1.18 +accessed. LEMON provides several physical graph structures to meet
1.19 +the diverging requirements of the possible users. In order to save on
1.20 +running time or on memory usage, some structures may fail to provide
1.21 +some graph features like edge or node deletion.
1.22
1.23 Alteration of standard containers need a very limited number of
1.24 operations, these together satisfy the everyday requirements.
1.25 @@ -76,7 +77,7 @@
1.26 Map adaptors are used to create "implicit" maps from other maps.
1.27
1.28 Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
1.29 -make arithmetic oprerations between one or two maps (negation, scalig,
1.30 +make arithmetic oprerations between one or two maps (negation, scaling,
1.31 addition, multiplication etc.) or e.g. convert a map to another one
1.32 of different Value type.
1.33 */
1.34 @@ -86,10 +87,24 @@
1.35 @ingroup datas
1.36 \brief Two dimensional data storages.
1.37
1.38 -Two dimensional
1.39 -data storages.
1.40 +Two dimensional data storages.
1.41 */
1.42
1.43 +/**
1.44 +@defgroup paths Path Structures
1.45 +@ingroup datas
1.46 +\brief Path structures implemented in LEMON.
1.47 +
1.48 +LEMON provides flexible data structures
1.49 +to work with paths.
1.50 +
1.51 +All of them have the same interface, especially they can be built or extended
1.52 +using a standard Builder subclass. This make is easy to have e.g. the Dijkstra
1.53 +algorithm to store its result in any kind of path structure.
1.54 +
1.55 +\sa lemon::concept::Path
1.56 +
1.57 +*/
1.58
1.59 /**
1.60 @defgroup auxdat Auxiliary Data Structures
1.61 @@ -110,35 +125,25 @@
1.62 */
1.63
1.64 /**
1.65 -@defgroup galgs Graph Algorithms
1.66 -\brief This group describes the several graph algorithms
1.67 +@defgroup algs Algorithms
1.68 +\brief This group describes the several algorithms
1.69 implemented in LEMON.
1.70
1.71 -This group describes the several graph algorithms
1.72 +This group describes the several algorithms
1.73 implemented in LEMON.
1.74 */
1.75
1.76 /**
1.77 @defgroup gutils General Graph Utilities
1.78 -@ingroup galgs
1.79 +@ingroup algs
1.80 \brief This group describes some simple general graph utilities.
1.81
1.82 This group describes some simple general graph utilities.
1.83 */
1.84
1.85 /**
1.86 -@defgroup gen_opt_group General Optimization Tools
1.87 -\brief This group describes some general optimization frameworks
1.88 -implemented in LEMON.
1.89 -
1.90 -This group describes some general optimization frameworks
1.91 -implemented in LEMON.
1.92 -
1.93 -*/
1.94 -
1.95 -/**
1.96 @defgroup flowalgs Path and Flow Algorithms
1.97 -@ingroup galgs
1.98 +@ingroup algs
1.99 \brief This group describes the algorithms
1.100 for finding paths and flows in graphs.
1.101
1.102 @@ -151,7 +156,7 @@
1.103
1.104 /**
1.105 @defgroup topology Topology related algorithms
1.106 -@ingroup galgs
1.107 +@ingroup algs
1.108 \brief This group describes the algorithms
1.109 for discover the topology of the graphs.
1.110
1.111 @@ -165,7 +170,7 @@
1.112
1.113 /**
1.114 @defgroup matching Matching algorithms in graphs and bipartite graphs
1.115 -@ingroup galgs
1.116 +@ingroup algs
1.117 \brief This group describes the algorithms
1.118 for find matchings in graphs and bipartite graphs.
1.119
1.120 @@ -178,8 +183,34 @@
1.121 */
1.122
1.123 /**
1.124 -@defgroup exceptions Exceptions
1.125 -This group contains the exceptions thrown by LEMON library
1.126 +@defgroup spantree Minimum Cost Spanning Tree Algorithms
1.127 +@ingroup algs
1.128 +\brief This group containes the algorithms for finding a minimum cost spanning
1.129 +tree in a graph
1.130 +
1.131 +This group containes the algorithms for finding a minimum cost spanning
1.132 +tree in a graph
1.133 +*/
1.134 +
1.135 +
1.136 +/**
1.137 +@defgroup auxalg Auxiliary Algorithms
1.138 +@ingroup algs
1.139 +\brief Some algorithms implemented in LEMON.
1.140 +
1.141 +This group describes the algorithms in LEMON in order to make
1.142 +it easier to implement complex algorithms.
1.143 +
1.144 +*/
1.145 +
1.146 +/**
1.147 +@defgroup gen_opt_group General Optimization Tools
1.148 +\brief This group describes some general optimization frameworks
1.149 +implemented in LEMON.
1.150 +
1.151 +This group describes some general optimization frameworks
1.152 +implemented in LEMON.
1.153 +
1.154 */
1.155
1.156 /**
1.157 @@ -197,13 +228,27 @@
1.158
1.159 /**
1.160 @defgroup io_group Input-Output
1.161 -Here you can find tools for imporing and exporting graphs and graph related
1.162 -data
1.163 +\brief Several Graph Input-Output methods
1.164 +
1.165 +Here you can find tools for importing and exporting graphs
1.166 +and graph related data. Now it supports the LEMON format, the
1.167 +dimacs format and the encapsulated postscript format.
1.168 +*/
1.169 +
1.170 +/**
1.171 +@defgroup lemon_io Lemon Input-Output
1.172 +@ingroup io_group
1.173 +\brief Reading and writing LEMON format
1.174 +
1.175 +Methods for reading and writing LEMON format. More about this
1.176 +format you can find on the \ref graph-io-page "Graph Input-Output"
1.177 +tutorial pages.
1.178 +
1.179 */
1.180
1.181 /**
1.182 @defgroup section_io Section readers and writers
1.183 -@ingroup io_group
1.184 +@ingroup lemon_io
1.185 \brief Section readers and writers for lemon Input-Output.
1.186
1.187 Here you can find which section readers and writers can attach to
1.188 @@ -212,7 +257,7 @@
1.189
1.190 /**
1.191 @defgroup item_io Item Readers and Writers
1.192 -@ingroup io_group
1.193 +@ingroup lemon_io
1.194 \brief Item readers and writers for lemon Input-Output.
1.195
1.196 The Input-Output classes can handle more data type by example
1.197 @@ -221,6 +266,20 @@
1.198 */
1.199
1.200 /**
1.201 +@defgroup eps_io Postscript exporting
1.202 +@ingroup io_group
1.203 +\brief General EPS drawer and graph exporter
1.204 +
1.205 +This group contains general EPS drawing methods and special
1.206 +graph exporting tools.
1.207 +*/
1.208 +
1.209 +/**
1.210 +@defgroup exceptions Exceptions
1.211 +This group contains the exceptions thrown by LEMON library
1.212 +*/
1.213 +
1.214 +/**
1.215 @defgroup concept Concepts
1.216 \brief Skeleton classes and concept checking classes
1.217
1.218 @@ -234,6 +293,7 @@
1.219
1.220 */
1.221
1.222 +
1.223 /**
1.224 @defgroup graph_concepts Graph Structure Concepts
1.225 @ingroup concept