Changeset 2084:59769591eb60 in lemon-0.x for doc/groups.dox

Timestamp:

05/15/06 11:49:51 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2749

Message:

Documentation improvements

Rearrangements:

IO modules
Algorithms

New documentation:

SwapBpUGraphAdaptor

Demos:

strongly_connected_orientation.cc

Benchmarks:

swap_bipartite_bench.cc

File:

• doc/groups.dox (modified) (10 diffs)

doc/groups.dox

@@ -15 +15 @@
 and thereafter the program code can be made efficient by small modifications. 
 
-The most efficient implementation of diverse applications require the usage of different physical graph implementations. These differences appear in the size of 
-graph we require to handle, memory or time usage limitations or in 
-the set of operations through which the graph can be accessed. 
-LEMON provides several physical graph structures to meet the 
-diverging requirements of the possible users. 
-In order to save on running time or on memory usage, some structures may 
-fail to provide some graph features like edge or node deletion.
+The most efficient implementation of diverse applications require the
+usage of different physical graph implementations. These differences
+appear in the size of graph we require to handle, memory or time usage
+limitations or in the set of operations through which the graph can be
+accessed.  LEMON provides several physical graph structures to meet
+the diverging requirements of the possible users.  In order to save on
+running time or on memory usage, some structures may fail to provide
+some graph features like edge or node deletion.
 
 Alteration of standard containers need a very limited number of 
@@ -77 +78 @@
 
 Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
-make arithmetic oprerations between one or two maps (negation, scalig,
+make arithmetic oprerations between one or two maps (negation, scaling,
 addition, multiplication etc.) or e.g. convert a map to another one
 of different Value type.
@@ -87 +88 @@
 \brief Two dimensional data storages.
 
-Two dimensional
-data storages.
-*/
-
+Two dimensional data storages.
+*/
+
+/**
+@defgroup paths Path Structures
+@ingroup datas
+\brief Path structures implemented in LEMON.
+
+LEMON provides flexible data structures
+to work with paths.
+
+All of them have the same interface, especially they can be built or extended
+using a standard Builder subclass. This make is easy to have e.g. the Dijkstra
+algorithm to store its result in any kind of path structure.
+
+\sa lemon::concept::Path
+
+*/
 
 /**
@@ -111 +126 @@
 
 /**
-@defgroup galgs Graph Algorithms
-\brief This group describes the several graph algorithms
+@defgroup algs Algorithms
+\brief This group describes the several algorithms
 implemented in LEMON.
 
-This group describes the several graph algorithms
+This group describes the several algorithms
 implemented in LEMON.
 */
@@ -121 +136 @@
 /**
 @defgroup gutils General Graph Utilities
-@ingroup galgs
+@ingroup algs
 \brief This group describes some simple general graph utilities.
 
 This group describes some simple general graph utilities.
+*/
+
+/**
+@defgroup flowalgs Path and Flow Algorithms
+@ingroup algs
+\brief This group describes the algorithms
+for finding paths and flows in graphs.
+
+This group describes the algorithms
+for finding paths and flows in graphs.
+
+\image html flow.png
+\image latex flow.eps "Graph flow" width=\textwidth
+*/
+
+/**
+@defgroup topology Topology related algorithms
+@ingroup algs
+\brief This group describes the algorithms
+for discover the topology of the graphs.
+
+This group describes the algorithms
+for discover the topology of the graphs.
+
+\image html edge_biconnected_components.png
+\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
+
+*/
+
+/**
+@defgroup matching Matching algorithms in graphs and bipartite graphs
+@ingroup algs
+\brief This group describes the algorithms
+for find matchings in graphs and bipartite graphs.
+
+This group provides some algorithm objects and function
+to calculate matchings in graphs and bipartite graphs.
+
+\image html bipartite_matching.png
+\image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
+
+*/
+
+/**
+@defgroup spantree Minimum Cost Spanning Tree Algorithms
+@ingroup algs
+\brief This group containes the algorithms for finding a minimum cost spanning
+tree in a graph
+
+This group containes the algorithms for finding a minimum cost spanning
+tree in a graph
+*/
+
+
+/**
+@defgroup auxalg Auxiliary Algorithms
+@ingroup algs
+\brief Some algorithms implemented in LEMON.
+
+This group describes the algorithms in LEMON in order to make 
+it easier to implement complex algorithms.
+
 */
 
@@ -135 +212 @@
 implemented in LEMON.
 
-*/
-
-/**
-@defgroup flowalgs Path and Flow Algorithms
-@ingroup galgs
-\brief This group describes the algorithms
-for finding paths and flows in graphs.
-
-This group describes the algorithms
-for finding paths and flows in graphs.
-
-\image html flow.png
-\image latex flow.eps "Graph flow" width=\textwidth
-*/
-
-/**
-@defgroup topology Topology related algorithms
-@ingroup galgs
-\brief This group describes the algorithms
-for discover the topology of the graphs.
-
-This group describes the algorithms
-for discover the topology of the graphs.
-
-\image html edge_biconnected_components.png
-\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
-
-*/
-
-/**
-@defgroup matching Matching algorithms in graphs and bipartite graphs
-@ingroup galgs
-\brief This group describes the algorithms
-for find matchings in graphs and bipartite graphs.
-
-This group provides some algorithm objects and function
-to calculate matchings in graphs and bipartite graphs.
-
-\image html bipartite_matching.png
-\image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
-
-*/
-
-/**
-@defgroup exceptions Exceptions
-This group contains the exceptions thrown by LEMON library
 */
 
@@ -198 +229 @@
 /**
 @defgroup io_group Input-Output
-Here you can find tools for imporing and exporting graphs and graph related
-data
+\brief Several Graph Input-Output methods
+
+Here you can find tools for importing and exporting graphs 
+and graph related data. Now it supports the LEMON format, the
+dimacs format and the encapsulated postscript format.
+*/
+
+/**
+@defgroup lemon_io Lemon Input-Output
+@ingroup io_group
+\brief Reading and writing LEMON format
+
+Methods for reading and writing LEMON format. More about this
+format you can find on the \ref graph-io-page "Graph Input-Output"
+tutorial pages.
+
 */
 
 /**
 @defgroup section_io Section readers and writers
-@ingroup io_group
+@ingroup lemon_io
 \brief Section readers and writers for lemon Input-Output.
 
@@ -213 +258 @@
 /**
 @defgroup item_io Item Readers and Writers
-@ingroup io_group
+@ingroup lemon_io
 \brief Item readers and writers for lemon Input-Output.
 
@@ -222 +267 @@
 
 /**
+@defgroup eps_io Postscript exporting
+@ingroup io_group
+\brief General EPS drawer and graph exporter
+
+This group contains general EPS drawing methods and special
+graph exporting tools. 
+*/
+
+/**
+@defgroup exceptions Exceptions
+This group contains the exceptions thrown by LEMON library
+*/
+
+/**
 @defgroup concept Concepts
 \brief Skeleton classes and concept checking classes
@@ -234 +293 @@
 
 */
+
 
 /**