doc/groups.dox
 branch 1.0 changeset 325 3a2e0692eaae parent 236 da953e387d31 child 327 12626fc94ccf
     1.1 --- a/doc/groups.dox	Wed Oct 08 10:33:42 2008 +0100
1.2 +++ b/doc/groups.dox	Thu Oct 09 13:47:26 2008 +0200
1.3 @@ -40,34 +40,12 @@
1.4  running time or on memory usage, some structures may fail to provide
1.5  some graph features like arc/edge or node deletion.
1.6
1.7 -Alteration of standard containers need a very limited number of
1.8 -operations, these together satisfy the everyday requirements.
1.9 -In the case of graph structures, different operations are needed which do
1.10 -not alter the physical graph, but gives another view. If some nodes or
1.11 -arcs have to be hidden or the reverse oriented graph have to be used, then
1.12 -this is the case. It also may happen that in a flow implementation
1.13 -the residual graph can be accessed by another algorithm, or a node-set
1.14 -is to be shrunk for another algorithm.
1.15 -LEMON also provides a variety of graphs for these requirements called
1.16 -\ref graph_adaptors "graph adaptors". Adaptors cannot be used alone but only
1.17 -in conjunction with other graph representations.
1.18 -
1.19  You are free to use the graph structure that fit your requirements
1.20  the best, most graph algorithms and auxiliary data structures can be used
1.21  with any graph structures.
1.22  */
1.23
1.24  /**
1.25 -@defgroup semi_adaptors Semi-Adaptor Classes for Graphs
1.26 -@ingroup graphs
1.27 -\brief Graph types between real graphs and graph adaptors.
1.28 -
1.29 -This group describes some graph types between real graphs and graph adaptors.
1.30 -These classes wrap graphs to give new functionality as the adaptors do it.
1.31 -On the other hand they are not light-weight structures as the adaptors.
1.32 -*/
1.33 -
1.34 -/**
1.35  @defgroup maps Maps
1.36  @ingroup datas
1.37  \brief Map structures implemented in LEMON.
1.38 @@ -152,14 +130,6 @@
1.39  */
1.40
1.41  /**
1.42 -@defgroup matrices Matrices
1.43 -@ingroup datas
1.44 -\brief Two dimensional data storages implemented in LEMON.
1.45 -
1.46 -This group describes two dimensional data storages implemented in LEMON.
1.47 -*/
1.48 -
1.49 -/**
1.50  @defgroup paths Path Structures
1.51  @ingroup datas
1.52  \brief Path structures implemented in LEMON.
1.53 @@ -213,145 +183,6 @@
1.54  */
1.55
1.56  /**
1.57 -@defgroup max_flow Maximum Flow algorithms
1.58 -@ingroup algs
1.59 -\brief Algorithms for finding maximum flows.
1.60 -
1.61 -This group describes the algorithms for finding maximum flows and
1.62 -feasible circulations.
1.63 -
1.64 -The maximum flow problem is to find a flow between a single source and
1.65 -a single target that is maximum. Formally, there is a \f$G=(V,A)\f$
1.66 -directed graph, an \f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity
1.67 -function and given \f$s, t \in V\f$ source and target node. The
1.68 -maximum flow is the \f$f_a\f$ solution of the next optimization problem:
1.69 -
1.70 -\f[ 0 \le f_a \le c_a \f]
1.71 -\f[ \sum_{v\in\delta^{-}(u)}f_{vu}=\sum_{v\in\delta^{+}(u)}f_{uv}
1.72 -\qquad \forall u \in V \setminus \{s,t\}\f]
1.73 -\f[ \max \sum_{v\in\delta^{+}(s)}f_{uv} - \sum_{v\in\delta^{-}(s)}f_{vu}\f]
1.74 -
1.75 -LEMON contains several algorithms for solving maximum flow problems:
1.76 -- \ref lemon::EdmondsKarp "Edmonds-Karp"
1.77 -- \ref lemon::Preflow "Goldberg's Preflow algorithm"
1.78 -- \ref lemon::DinitzSleatorTarjan "Dinitz's blocking flow algorithm with dynamic trees"
1.79 -- \ref lemon::GoldbergTarjan "Preflow algorithm with dynamic trees"
1.80 -
1.81 -In most cases the \ref lemon::Preflow "Preflow" algorithm provides the
1.82 -fastest method to compute the maximum flow. All impelementations
1.83 -provides functions to query the minimum cut, which is the dual linear
1.84 -programming problem of the maximum flow.
1.85 -
1.86 -*/
1.87 -
1.88 -/**
1.89 -@defgroup min_cost_flow Minimum Cost Flow algorithms
1.90 -@ingroup algs
1.91 -
1.92 -\brief Algorithms for finding minimum cost flows and circulations.
1.93 -
1.94 -This group describes the algorithms for finding minimum cost flows and
1.95 -circulations.
1.96 -*/
1.97 -
1.98 -/**
1.99 -@defgroup min_cut Minimum Cut algorithms
1.100 -@ingroup algs
1.101 -
1.102 -\brief Algorithms for finding minimum cut in graphs.
1.103 -
1.104 -This group describes the algorithms for finding minimum cut in graphs.
1.105 -
1.106 -The minimum cut problem is to find a non-empty and non-complete
1.107 -\f$X\f$ subset of the vertices with minimum overall capacity on
1.108 -outgoing arcs. Formally, there is \f$G=(V,A)\f$ directed graph, an
1.109 -\f$c_a:A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum
1.110 -cut is the \f$X\f$ solution of the next optimization problem:
1.111 -
1.112 -\f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}
1.113 -\sum_{uv\in A, u\in X, v\not\in X}c_{uv}\f]
1.114 -
1.115 -LEMON contains several algorithms related to minimum cut problems:
1.116 -
1.117 -- \ref lemon::HaoOrlin "Hao-Orlin algorithm" to calculate minimum cut
1.118 -  in directed graphs
1.119 -- \ref lemon::NagamochiIbaraki "Nagamochi-Ibaraki algorithm" to
1.120 -  calculate minimum cut in undirected graphs
1.121 -- \ref lemon::GomoryHuTree "Gomory-Hu tree computation" to calculate all
1.122 -  pairs minimum cut in undirected graphs
1.123 -
1.124 -If you want to find minimum cut just between two distinict nodes,
1.125 -please see the \ref max_flow "Maximum Flow page".
1.126 -
1.127 -*/
1.128 -
1.129 -/**
1.130 -@defgroup graph_prop Connectivity and other graph properties
1.131 -@ingroup algs
1.132 -\brief Algorithms for discovering the graph properties
1.133 -
1.134 -This group describes the algorithms for discovering the graph properties
1.135 -like connectivity, bipartiteness, euler property, simplicity etc.
1.136 -
1.137 -\image html edge_biconnected_components.png
1.138 -\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
1.139 -*/
1.140 -
1.141 -/**
1.142 -@defgroup planar Planarity embedding and drawing
1.143 -@ingroup algs
1.144 -\brief Algorithms for planarity checking, embedding and drawing
1.145 -
1.146 -This group describes the algorithms for planarity checking,
1.147 -embedding and drawing.
1.148 -
1.149 -\image html planar.png
1.150 -\image latex planar.eps "Plane graph" width=\textwidth
1.151 -*/
1.152 -
1.153 -/**
1.154 -@defgroup matching Matching algorithms
1.155 -@ingroup algs
1.156 -\brief Algorithms for finding matchings in graphs and bipartite graphs.
1.157 -
1.158 -This group contains algorithm objects and functions to calculate
1.159 -matchings in graphs and bipartite graphs. The general matching problem is
1.160 -finding a subset of the arcs which does not shares common endpoints.
1.161 -
1.162 -There are several different algorithms for calculate matchings in
1.163 -graphs.  The matching problems in bipartite graphs are generally
1.164 -easier than in general graphs. The goal of the matching optimization
1.165 -can be the finding maximum cardinality, maximum weight or minimum cost
1.166 -matching. The search can be constrained to find perfect or
1.167 -maximum cardinality matching.
1.168 -
1.169 -LEMON contains the next algorithms:
1.170 -- \ref lemon::MaxBipartiteMatching "MaxBipartiteMatching" Hopcroft-Karp
1.171 -  augmenting path algorithm for calculate maximum cardinality matching in
1.172 -  bipartite graphs
1.173 -- \ref lemon::PrBipartiteMatching "PrBipartiteMatching" Push-Relabel
1.174 -  algorithm for calculate maximum cardinality matching in bipartite graphs
1.175 -- \ref lemon::MaxWeightedBipartiteMatching "MaxWeightedBipartiteMatching"
1.176 -  Successive shortest path algorithm for calculate maximum weighted matching
1.177 -  and maximum weighted bipartite matching in bipartite graph
1.178 -- \ref lemon::MinCostMaxBipartiteMatching "MinCostMaxBipartiteMatching"
1.179 -  Successive shortest path algorithm for calculate minimum cost maximum
1.180 -  matching in bipartite graph
1.181 -- \ref lemon::MaxMatching "MaxMatching" Edmond's blossom shrinking algorithm
1.182 -  for calculate maximum cardinality matching in general graph
1.183 -- \ref lemon::MaxWeightedMatching "MaxWeightedMatching" Edmond's blossom
1.184 -  shrinking algorithm for calculate maximum weighted matching in general
1.185 -  graph
1.186 -- \ref lemon::MaxWeightedPerfectMatching "MaxWeightedPerfectMatching"
1.187 -  Edmond's blossom shrinking algorithm for calculate maximum weighted
1.188 -  perfect matching in general graph
1.189 -
1.190 -\image html bipartite_matching.png
1.191 -\image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
1.192 -
1.193 -*/
1.194 -
1.195 -/**
1.196  @defgroup spantree Minimum Spanning Tree algorithms
1.197  @ingroup algs
1.198  \brief Algorithms for finding a minimum cost spanning tree in a graph.
1.199 @@ -360,62 +191,6 @@
1.200  tree in a graph
1.201  */
1.202
1.203 -
1.204 -/**
1.205 -@defgroup auxalg Auxiliary algorithms
1.206 -@ingroup algs
1.207 -\brief Auxiliary algorithms implemented in LEMON.
1.208 -
1.209 -This group describes some algorithms implemented in LEMON
1.210 -in order to make it easier to implement complex algorithms.
1.211 -*/
1.212 -
1.213 -/**
1.214 -@defgroup approx Approximation algorithms
1.215 -\brief Approximation algorithms.
1.216 -
1.217 -This group describes the approximation and heuristic algorithms
1.218 -implemented in LEMON.
1.219 -*/
1.220 -
1.221 -/**
1.222 -@defgroup gen_opt_group General Optimization Tools
1.223 -\brief This group describes some general optimization frameworks
1.224 -implemented in LEMON.
1.225 -
1.226 -This group describes some general optimization frameworks
1.227 -implemented in LEMON.
1.228 -
1.229 -*/
1.230 -
1.231 -/**
1.232 -@defgroup lp_group Lp and Mip solvers
1.233 -@ingroup gen_opt_group
1.234 -\brief Lp and Mip solver interfaces for LEMON.
1.235 -
1.236 -This group describes Lp and Mip solver interfaces for LEMON. The
1.237 -various LP solvers could be used in the same manner with this
1.238 -interface.
1.239 -
1.240 -*/
1.241 -
1.242 -/**
1.243 -@defgroup lp_utils Tools for Lp and Mip solvers
1.244 -@ingroup lp_group
1.245 -\brief Helper tools to the Lp and Mip solvers.
1.246 -
1.247 -This group adds some helper tools to general optimization framework
1.248 -implemented in LEMON.
1.249 -*/
1.250 -
1.251 -/**
1.252 -@defgroup metah Metaheuristics
1.253 -@ingroup gen_opt_group
1.254 -\brief Metaheuristics for LEMON library.
1.255 -
1.256 -This group describes some metaheuristic optimization tools.
1.257 -*/
1.258 -
1.259  /**
1.260  @defgroup utils Tools and Utilities
1.261  \brief Tools and utilities for programming in LEMON
1.262 @@ -450,15 +225,6 @@
1.263  */
1.264
1.265  /**
1.266 -@defgroup graphbits Tools for Graph Implementation
1.267 -@ingroup utils
1.268 -\brief Tools to make it easier to create graphs.
1.269 -
1.270 -This group describes the tools that makes it easier to create graphs and
1.271 -the maps that dynamically update with the graph changes.
1.272 -*/
1.273 -
1.274 -/**
1.275  @defgroup exceptions Exceptions
1.276  @ingroup utils
1.277  \brief Exceptions defined in LEMON.
1.278 @@ -471,8 +237,8 @@
1.279  \brief Graph Input-Output methods
1.280
1.281  This group describes the tools for importing and exporting graphs
1.282 -and graph related data. Now it supports the LEMON format, the
1.283 -\c DIMACS format and the encapsulated postscript (EPS) format.
1.284 +and graph related data. Now it supports the LEMON format
1.285 +and the encapsulated postscript (EPS) format.
1.286  */
1.287
1.288  /**
1.289 @@ -534,12 +300,6 @@
1.290  graph structures and helper classes used to implement these.
1.291  */
1.292
1.293 -/* --- Unused group
1.294 -@defgroup experimental Experimental Structures and Algorithms
1.295 -This group describes some Experimental structures and algorithms.
1.296 -The stuff here is subject to change.
1.297 -*/
1.298 -
1.299  /**
1.300  \anchor demoprograms
1.301
1.302 @@ -551,13 +311,3 @@
1.303  It order to compile them, use <tt>--enable-demo</tt> configure option when
1.304  build the library.
1.305  */
1.306 -
1.307 -/**
1.308 -@defgroup tools Standalone utility applications
1.309 -
1.310 -Some utility applications are listed here.
1.311 -
1.312 -The standard compilation procedure (<tt>./configure;make</tt>) will compile
1.313 -them, as well.
1.314 -*/
1.315 -