lemon-0.x: comparison doc/groups.dox

equal deleted inserted replaced

-:4fa276dc83fd
+:033291624de2
 The implementation of combinatorial algorithms heavily relies on
 efficient graph implementations. LEMON offers data structures which are
 planned to be easily used in an experimental phase of implementation studies,
 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
+The most efficient implementation of diverse applications require the
-graph we require to handle, memory or time usage limitations or in
+usage of different physical graph implementations. These differences
-the set of operations through which the graph can be accessed.
+appear in the size of graph we require to handle, memory or time usage
-LEMON provides several physical graph structures to meet the
+limitations or in the set of operations through which the graph can be
-diverging requirements of the possible users.
+accessed.  LEMON provides several physical graph structures to meet
-In order to save on running time or on memory usage, some structures may
+the diverging requirements of the possible users.  In order to save on
-fail to provide some graph features like edge or node deletion.
+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
 operations, these together satisfy the everyday requirements.
 In the case of graph strutures, different operations are needed which do
 not alter the physical graph, but gives another view. If some nodes or
 \brief Tools to create new maps from existing ones
 Map adaptors are used to create "implicit" maps from other maps.
 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.
 */
 /**
 @defgroup matrices Matrices
 @ingroup datas
 \brief Two dimensional data storages.
-Two dimensional
+Two dimensional data storages.
-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
+*/
 /**
 @defgroup auxdat Auxiliary Data Structures
 @ingroup datas
 \brief Some data structures implemented in LEMON.
 This group describes the tools that makes it easier to make graphs and
 the maps that dynamically update with the graph changes.
 */
 /**
-@defgroup galgs Graph Algorithms
+@defgroup algs Algorithms
-\brief This group describes the several graph 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.
 */
 /**
 @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.
 */
 /**
 @defgroup gen_opt_group General Optimization Tools
 \brief This group describes some general optimization frameworks
 implemented in LEMON.
 This group describes some general optimization frameworks
 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
 */
 /**
 @defgroup misc Miscellaneous Tools
 Here you can find several useful tools for development,
 of algorithms.
 */
 /**
 @defgroup io_group Input-Output
-Here you can find tools for imporing and exporting graphs and graph related
+\brief Several Graph Input-Output methods
-data
+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.
 Here you can find which section readers and writers can attach to
 the LemonReader and LemonWriter.
 */
 /**
 @defgroup item_io Item Readers and Writers
-@ingroup io_group
+@ingroup lemon_io
 \brief Item readers and writers for lemon Input-Output.
 The Input-Output classes can handle more data type by example
 as map or attribute value. Each of these should be written and
 read some way. The module make possible to do this.
 */
 /**
+@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
 This group describes the data/algorithm skeletons and concept checking
 classes implemented in LEMON.
 class or template function is correctly implemented.
 The other (sometimes even more important) aim is to document the concepts.
 */
 /**
 @defgroup graph_concepts Graph Structure Concepts
 @ingroup concept
 \brief Skeleton and concept checking classes for graph structures

changeset 2114	677ea6c8169a
parent 2072	224d3781b00b
child 2117	96efb4fa0736