Changes in doc/groups.dox [318:1e2d6ca80793:210:81cfc04531e8] in lemon-main

File:

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

doc/groups.dox

@@ -55 +55 @@
 You are free to use the graph structure that fit your requirements
 the best, most graph algorithms and auxiliary data structures can be used
-with any graph structure.
-
-<b>See also:</b> \ref graph_concepts "Graph Structure Concepts".
+with any graph structures.
 */
 
@@ -77 +75 @@
 This group describes the map structures implemented in LEMON.
 
-LEMON provides several special purpose maps and map adaptors that e.g. combine
+LEMON provides several special purpose maps that e.g. combine
 new maps from existing ones.
-
-<b>See also:</b> \ref map_concepts "Map Concepts".
 */
 
@@ -91 +87 @@
 values to the nodes and arcs of graphs.
 */
+
 
 /**
@@ -108 +105 @@
 algorithms.  If a function type algorithm is called then the function
 type map adaptors can be used comfortable. For example let's see the
-usage of map adaptors with the \c graphToEps() function.
+usage of map adaptors with the \c digraphToEps() function.
 \code
   Color nodeColor(int deg) {
@@ -122 +119 @@
   Digraph::NodeMap<int> degree_map(graph);
 
-  graphToEps(graph, "graph.eps")
+  digraphToEps(graph, "graph.eps")
     .coords(coords).scaleToA4().undirected()
     .nodeColors(composeMap(functorToMap(nodeColor), degree_map))
@@ -128 +125 @@
 \endcode
 The \c functorToMap() function makes an \c int to \c Color map from the
-\c nodeColor() function. The \c composeMap() compose the \c degree_map
+\e nodeColor() function. The \c composeMap() compose the \e degree_map
 and the previously created map. The composed map is a proper function to
 get the color of each node.
@@ -166 +163 @@
 @defgroup paths Path Structures
 @ingroup datas
-\brief %Path structures implemented in LEMON.
+\brief Path structures implemented in LEMON.
 
 This group describes the path structures implemented in LEMON.
@@ -177 +174 @@
 
 \sa lemon::concepts::Path
+
 */
 
@@ -188 +186 @@
 */
 
+
 /**
 @defgroup algs Algorithms
@@ -203 +202 @@
 
 This group describes the common graph search algorithms like
-Breadth-First Search (BFS) and Depth-First Search (DFS).
-*/
-
-/**
-@defgroup shortest_path Shortest Path Algorithms
+Breadth-first search (Bfs) and Depth-first search (Dfs).
+*/
+
+/**
+@defgroup shortest_path Shortest Path algorithms
 @ingroup algs
 \brief Algorithms for finding shortest paths.
@@ -215 +214 @@
 
 /**
-@defgroup max_flow Maximum Flow Algorithms
+@defgroup max_flow Maximum Flow algorithms
 @ingroup algs
 \brief Algorithms for finding maximum flows.
@@ -243 +242 @@
 provides functions to query the minimum cut, which is the dual linear
 programming problem of the maximum flow.
-*/
-
-/**
-@defgroup min_cost_flow Minimum Cost Flow Algorithms
+
+*/
+
+/**
+@defgroup min_cost_flow Minimum Cost Flow algorithms
 @ingroup algs
 
@@ -256 +256 @@
 
 /**
-@defgroup min_cut Minimum Cut Algorithms
+@defgroup min_cut Minimum Cut algorithms
 @ingroup algs
 
@@ -283 +283 @@
 If you want to find minimum cut just between two distinict nodes,
 please see the \ref max_flow "Maximum Flow page".
-*/
-
-/**
-@defgroup graph_prop Connectivity and Other Graph Properties
+
+*/
+
+/**
+@defgroup graph_prop Connectivity and other graph properties
 @ingroup algs
 \brief Algorithms for discovering the graph properties
@@ -298 +299 @@
 
 /**
-@defgroup planar Planarity Embedding and Drawing
+@defgroup planar Planarity embedding and drawing
 @ingroup algs
 \brief Algorithms for planarity checking, embedding and drawing
@@ -310 +311 @@
 
 /**
-@defgroup matching Matching Algorithms
+@defgroup matching Matching algorithms
 @ingroup algs
 \brief Algorithms for finding matchings in graphs and bipartite graphs.
@@ -325 +326 @@
 maximum cardinality matching.
 
-LEMON contains the next algorithms:
+Lemon contains the next algorithms:
 - \ref lemon::MaxBipartiteMatching "MaxBipartiteMatching" Hopcroft-Karp
   augmenting path algorithm for calculate maximum cardinality matching in
@@ -348 +349 @@
 \image html bipartite_matching.png
 \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
-*/
-
-/**
-@defgroup spantree Minimum Spanning Tree Algorithms
+
+*/
+
+/**
+@defgroup spantree Minimum Spanning Tree algorithms
 @ingroup algs
 \brief Algorithms for finding a minimum cost spanning tree in a graph.
@@ -359 +361 @@
 */
 
-/**
-@defgroup auxalg Auxiliary Algorithms
+
+/**
+@defgroup auxalg Auxiliary algorithms
 @ingroup algs
 \brief Auxiliary algorithms implemented in LEMON.
@@ -369 +372 @@
 
 /**
-@defgroup approx Approximation Algorithms
-@ingroup algs
+@defgroup approx Approximation algorithms
 \brief Approximation algorithms.
 
@@ -384 +386 @@
 This group describes some general optimization frameworks
 implemented in LEMON.
-*/
-
-/**
-@defgroup lp_group Lp and Mip Solvers
+
+*/
+
+/**
+@defgroup lp_group Lp and Mip solvers
 @ingroup gen_opt_group
 \brief Lp and Mip solver interfaces for LEMON.
@@ -394 +397 @@
 various LP solvers could be used in the same manner with this
 interface.
-*/
-
-/**
-@defgroup lp_utils Tools for Lp and Mip Solvers
+
+*/
+
+/**
+@defgroup lp_utils Tools for Lp and Mip solvers
 @ingroup lp_group
 \brief Helper tools to the Lp and Mip solvers.
@@ -438 +442 @@
 
 /**
-@defgroup timecount Time Measuring and Counting
+@defgroup timecount Time measuring and Counting
 @ingroup misc
 \brief Simple tools for measuring the performance of algorithms.
@@ -444 +448 @@
 This group describes simple tools for measuring the performance
 of algorithms.
+*/
+
+/**
+@defgroup graphbits Tools for Graph Implementation
+@ingroup utils
+\brief Tools to make it easier to create graphs.
+
+This group describes the tools that makes it easier to create graphs and
+the maps that dynamically update with the graph changes.
 */
 
@@ -459 +472 @@
 
 This group describes the tools for importing and exporting graphs
-and graph related data. Now it supports the \ref lgf-format
-"LEMON Graph Format", the \c DIMACS format and the encapsulated
-postscript (EPS) format.
-*/
-
-/**
-@defgroup lemon_io LEMON Input-Output
+and graph related data. Now it supports the LEMON format, the
+\c DIMACS format and the encapsulated postscript (EPS) format.
+*/
+
+/**
+@defgroup lemon_io Lemon Input-Output
 @ingroup io_group
-\brief Reading and writing LEMON Graph Format.
+\brief Reading and writing \ref lgf-format "Lemon Graph Format".
 
 This group describes methods for reading and writing
-\ref lgf-format "LEMON Graph Format".
-*/
-
-/**
-@defgroup eps_io Postscript Exporting
+\ref lgf-format "Lemon Graph Format".
+*/
+
+/**
+@defgroup eps_io Postscript exporting
 @ingroup io_group
 \brief General \c EPS drawer and graph exporter
@@ -482 +494 @@
 */
 
+
 /**
 @defgroup concept Concepts
@@ -491 +504 @@
 The purpose of the classes in this group is fourfold.
 
-- These classes contain the documentations of the %concepts. In order
+- These classes contain the documentations of the concepts. In order
   to avoid document multiplications, an implementation of a concept
   simply refers to the corresponding concept class.
 
 - These classes declare every functions, <tt>typedef</tt>s etc. an
-  implementation of the %concepts should provide, however completely
+  implementation of the concepts should provide, however completely
   without implementations and real data structures behind the
   interface. On the other hand they should provide nothing else. All
@@ -509 +522 @@
 
 - Finally, They can serve as a skeleton of a new implementation of a concept.
-*/
+
+*/
+
 
 /**
@@ -520 +535 @@
 */
 
-/**
-@defgroup map_concepts Map Concepts
-@ingroup concept
-\brief Skeleton and concept checking classes for maps
-
-This group describes the skeletons and concept checking classes of maps.
+/* --- Unused group
+@defgroup experimental Experimental Structures and Algorithms
+This group describes some Experimental structures and algorithms.
+The stuff here is subject to change.
 */