doc/groups.dox
changeset 761 98a30824fe36
parent 760 4ac30454f1c1
child 762 ece80147fb08
equal deleted inserted replaced
35:4f8d435a257d 36:17a8d576cb6d
   224 class. We use the implicit minimum time map as the length map of the
   224 class. We use the implicit minimum time map as the length map of the
   225 \c Dijkstra algorithm.
   225 \c Dijkstra algorithm.
   226 */
   226 */
   227 
   227 
   228 /**
   228 /**
   229 @defgroup matrices Matrices
       
   230 @ingroup datas
       
   231 \brief Two dimensional data storages implemented in LEMON.
       
   232 
       
   233 This group contains two dimensional data storages implemented in LEMON.
       
   234 */
       
   235 
       
   236 /**
       
   237 @defgroup paths Path Structures
   229 @defgroup paths Path Structures
   238 @ingroup datas
   230 @ingroup datas
   239 \brief %Path structures implemented in LEMON.
   231 \brief %Path structures implemented in LEMON.
   240 
   232 
   241 This group contains the path structures implemented in LEMON.
   233 This group contains the path structures implemented in LEMON.
   254 @ingroup datas
   246 @ingroup datas
   255 \brief Auxiliary data structures implemented in LEMON.
   247 \brief Auxiliary data structures implemented in LEMON.
   256 
   248 
   257 This group contains some data structures implemented in LEMON in
   249 This group contains some data structures implemented in LEMON in
   258 order to make it easier to implement combinatorial algorithms.
   250 order to make it easier to implement combinatorial algorithms.
       
   251 */
       
   252 
       
   253 /**
       
   254 @defgroup geomdat Geometric Data Structures
       
   255 @ingroup auxdat
       
   256 \brief Geometric data structures implemented in LEMON.
       
   257 
       
   258 This group contains geometric data structures implemented in LEMON.
       
   259 
       
   260  - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional
       
   261    vector with the usual operations.
       
   262  - \ref lemon::dim2::Box "dim2::Box" can be used to determine the
       
   263    rectangular bounding box of a set of \ref lemon::dim2::Point
       
   264    "dim2::Point"'s.
       
   265 */
       
   266 
       
   267 /**
       
   268 @defgroup matrices Matrices
       
   269 @ingroup auxdat
       
   270 \brief Two dimensional data storages implemented in LEMON.
       
   271 
       
   272 This group contains two dimensional data storages implemented in LEMON.
   259 */
   273 */
   260 
   274 
   261 /**
   275 /**
   262 @defgroup algs Algorithms
   276 @defgroup algs Algorithms
   263 \brief This group contains the several algorithms
   277 \brief This group contains the several algorithms
   296  - \ref Suurballe A successive shortest path algorithm for finding
   310  - \ref Suurballe A successive shortest path algorithm for finding
   297    arc-disjoint paths between two nodes having minimum total length.
   311    arc-disjoint paths between two nodes having minimum total length.
   298 */
   312 */
   299 
   313 
   300 /**
   314 /**
       
   315 @defgroup spantree Minimum Spanning Tree Algorithms
       
   316 @ingroup algs
       
   317 \brief Algorithms for finding minimum cost spanning trees and arborescences.
       
   318 
       
   319 This group contains the algorithms for finding minimum cost spanning
       
   320 trees and arborescences.
       
   321 */
       
   322 
       
   323 /**
   301 @defgroup max_flow Maximum Flow Algorithms
   324 @defgroup max_flow Maximum Flow Algorithms
   302 @ingroup algs
   325 @ingroup algs
   303 \brief Algorithms for finding maximum flows.
   326 \brief Algorithms for finding maximum flows.
   304 
   327 
   305 This group contains the algorithms for finding maximum flows and
   328 This group contains the algorithms for finding maximum flows and
   386 - \ref GomoryHu "Gomory-Hu tree computation" for calculating
   409 - \ref GomoryHu "Gomory-Hu tree computation" for calculating
   387   all-pairs minimum cut in undirected graphs.
   410   all-pairs minimum cut in undirected graphs.
   388 
   411 
   389 If you want to find minimum cut just between two distinict nodes,
   412 If you want to find minimum cut just between two distinict nodes,
   390 see the \ref max_flow "maximum flow problem".
   413 see the \ref max_flow "maximum flow problem".
   391 */
       
   392 
       
   393 /**
       
   394 @defgroup graph_properties Connectivity and Other Graph Properties
       
   395 @ingroup algs
       
   396 \brief Algorithms for discovering the graph properties
       
   397 
       
   398 This group contains the algorithms for discovering the graph properties
       
   399 like connectivity, bipartiteness, euler property, simplicity etc.
       
   400 
       
   401 \image html connected_components.png
       
   402 \image latex connected_components.eps "Connected components" width=\textwidth
       
   403 */
       
   404 
       
   405 /**
       
   406 @defgroup planar Planarity Embedding and Drawing
       
   407 @ingroup algs
       
   408 \brief Algorithms for planarity checking, embedding and drawing
       
   409 
       
   410 This group contains the algorithms for planarity checking,
       
   411 embedding and drawing.
       
   412 
       
   413 \image html planar.png
       
   414 \image latex planar.eps "Plane graph" width=\textwidth
       
   415 */
   414 */
   416 
   415 
   417 /**
   416 /**
   418 @defgroup matching Matching Algorithms
   417 @defgroup matching Matching Algorithms
   419 @ingroup algs
   418 @ingroup algs
   453 \image html bipartite_matching.png
   452 \image html bipartite_matching.png
   454 \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
   453 \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
   455 */
   454 */
   456 
   455 
   457 /**
   456 /**
   458 @defgroup spantree Minimum Spanning Tree Algorithms
   457 @defgroup graph_properties Connectivity and Other Graph Properties
   459 @ingroup algs
   458 @ingroup algs
   460 \brief Algorithms for finding minimum cost spanning trees and arborescences.
   459 \brief Algorithms for discovering the graph properties
   461 
   460 
   462 This group contains the algorithms for finding minimum cost spanning
   461 This group contains the algorithms for discovering the graph properties
   463 trees and arborescences.
   462 like connectivity, bipartiteness, euler property, simplicity etc.
       
   463 
       
   464 \image html connected_components.png
       
   465 \image latex connected_components.eps "Connected components" width=\textwidth
       
   466 */
       
   467 
       
   468 /**
       
   469 @defgroup planar Planarity Embedding and Drawing
       
   470 @ingroup algs
       
   471 \brief Algorithms for planarity checking, embedding and drawing
       
   472 
       
   473 This group contains the algorithms for planarity checking,
       
   474 embedding and drawing.
       
   475 
       
   476 \image html planar.png
       
   477 \image latex planar.eps "Plane graph" width=\textwidth
       
   478 */
       
   479 
       
   480 /**
       
   481 @defgroup approx Approximation Algorithms
       
   482 @ingroup algs
       
   483 \brief Approximation algorithms.
       
   484 
       
   485 This group contains the approximation and heuristic algorithms
       
   486 implemented in LEMON.
   464 */
   487 */
   465 
   488 
   466 /**
   489 /**
   467 @defgroup auxalg Auxiliary Algorithms
   490 @defgroup auxalg Auxiliary Algorithms
   468 @ingroup algs
   491 @ingroup algs
   469 \brief Auxiliary algorithms implemented in LEMON.
   492 \brief Auxiliary algorithms implemented in LEMON.
   470 
   493 
   471 This group contains some algorithms implemented in LEMON
   494 This group contains some algorithms implemented in LEMON
   472 in order to make it easier to implement complex algorithms.
   495 in order to make it easier to implement complex algorithms.
   473 */
       
   474 
       
   475 /**
       
   476 @defgroup approx Approximation Algorithms
       
   477 @ingroup algs
       
   478 \brief Approximation algorithms.
       
   479 
       
   480 This group contains the approximation and heuristic algorithms
       
   481 implemented in LEMON.
       
   482 */
   496 */
   483 
   497 
   484 /**
   498 /**
   485 @defgroup gen_opt_group General Optimization Tools
   499 @defgroup gen_opt_group General Optimization Tools
   486 \brief This group contains some general optimization frameworks
   500 \brief This group contains some general optimization frameworks
   585 This group contains general \c EPS drawing methods and special
   599 This group contains general \c EPS drawing methods and special
   586 graph exporting tools.
   600 graph exporting tools.
   587 */
   601 */
   588 
   602 
   589 /**
   603 /**
   590 @defgroup dimacs_group DIMACS format
   604 @defgroup dimacs_group DIMACS Format
   591 @ingroup io_group
   605 @ingroup io_group
   592 \brief Read and write files in DIMACS format
   606 \brief Read and write files in DIMACS format
   593 
   607 
   594 Tools to read a digraph from or write it to a file in DIMACS format data.
   608 Tools to read a digraph from or write it to a file in DIMACS format data.
   595 */
   609 */
   647 
   661 
   648 This group contains the skeletons and concept checking classes of maps.
   662 This group contains the skeletons and concept checking classes of maps.
   649 */
   663 */
   650 
   664 
   651 /**
   665 /**
       
   666 @defgroup tools Standalone Utility Applications
       
   667 
       
   668 Some utility applications are listed here.
       
   669 
       
   670 The standard compilation procedure (<tt>./configure;make</tt>) will compile
       
   671 them, as well.
       
   672 */
       
   673 
       
   674 /**
   652 \anchor demoprograms
   675 \anchor demoprograms
   653 
   676 
   654 @defgroup demos Demo Programs
   677 @defgroup demos Demo Programs
   655 
   678 
   656 Some demo programs are listed here. Their full source codes can be found in
   679 Some demo programs are listed here. Their full source codes can be found in
   658 
   681 
   659 In order to compile them, use the <tt>make demo</tt> or the
   682 In order to compile them, use the <tt>make demo</tt> or the
   660 <tt>make check</tt> commands.
   683 <tt>make check</tt> commands.
   661 */
   684 */
   662 
   685 
   663 /**
       
   664 @defgroup tools Standalone Utility Applications
       
   665 
       
   666 Some utility applications are listed here.
       
   667 
       
   668 The standard compilation procedure (<tt>./configure;make</tt>) will compile
       
   669 them, as well.
       
   670 */
       
   671 
       
   672 }
   686 }