Changeset 2081:94a7deb46c07 in lemon-0.x for demo

Timestamp:

05/12/06 17:29:42 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

New demo file for computing disjoint paths

Doc review

Correcting misformatting in adaptors
Adding header to demos

Location:

demo

Files:

• Makefile.am (modified) (2 diffs)
• descriptor_map_demo.cc (modified) (2 diffs)
• dim_to_dot.cc (modified) (1 diff)
• disjoint_paths.cc (added)
• disjoint_paths.lgf (added)
• tight_edge_filter_map.h (modified) (2 diffs)

demo/Makefile.am

@@ -19 +19 @@
         grid_ugraph_demo \
         topology_demo \
-        simann_maxcut_demo
+        simann_maxcut_demo \
+        disjoint_paths_demo
 
 if HAVE_GLPK
@@ -67 +68 @@
 
 simann_maxcut_demo_SOURCES = simann_maxcut_demo.cc
+
+disjoint_paths_demo_SOURCES = disjoint_paths.cc

demo/descriptor_map_demo.cc

@@ -17 +17 @@
  */
 
+/// \ingroup demos
+/// \file
+/// \brief Using descriptor map and own special map types.
+///
+/// This demo shows how can be used the DescriptorMap class
+/// which helps to use unique label for each node or edge.
+/// And it gives an example how easy is creating own map types.
+///
+/// \include descriptor_map_demo.cc
+
 #include <lemon/list_graph.h>
 #include <lemon/graph_utils.h>
@@ -31 +41 @@
 using namespace lemon;
 
-// Special map type
-// It gives back a position for each node. The position of the nodes 
+// Special xy<double> map type 
+//
+// It gives back a position for each node. The position of the nodes
 // are on the circle with the given center and radius.
 //
-// Because we use the descriptor map it will hold the proprty described above
-// even if a node added or deleted. 
+// Because we use the descriptor map it will hold the proprty
+// described above even if a node added or deleted.
 template <typename Graph>
 class CircleMap {

demo/dim_to_dot.cc

@@ -17 +17 @@
  */
 
-// Use a DIMACS max flow file as stdin.
-// dim_to_dot < dimacs_max_flow_file > dot_output_file
-// This program makes a dot file from a dimacs max flow file. 
-// This program can be an aid in making up to date visualized documantation 
-// of demo programs.
-
-// For later documentation (if marci does not do it)
-// Az a graphviz csomag egy egyszeru formatuma, ami egy graphrajzolo csomag.
-// Az EdgeSubGraphAdaptor doksijaban szerepel egy kirajzolt graf. Azt nem
-// kezzel csinaltam, hanem a megfelelo dim file-bol ezzel a progival. A
-// doxygen ugyanis ilyet eszik, igy a juzer vizualisan is latja a grafot a
-// doksiban, es sajat maga is le tudja futtatni az algoritmust, mert ott van
-// a kezeben a dim file is. Es mivel ez egy generalt file, ezert ha vmit
-// valtoztatunk a dim-en, ezt is konnyu bemasolni. Uff.
-
+///\file
+///\brief Dim (Dimacs) to Dot (Graphviz) converter
+///
+/// This program can convert the dimacs format to graphviz dot format.
+///
+/// Use a DIMACS max flow file as stdin.
+///
+/// <tt>dim_to_dot < dimacs_max_flow_file > dot_output_file</tt>
+///
+/// This program makes a dot file from a dimacs max flow file. 
+/// This program can be an aid in making up to date visualized documantation 
+/// of demo programs.
+///
+/// \include dim_to_dot.cc
 
 #include <iostream>

demo/tight_edge_filter_map.h

@@ -17 +17 @@
  */
 
-#ifndef LEMON_TIGHT_EDGE_FILTER_MAP_H
-#define LEMON_TIGHT_EDGE_FILTER_MAP_H
+#ifndef DEMO_TIGHT_EDGE_FILTER_MAP_H
+#define DEMO_TIGHT_EDGE_FILTER_MAP_H
 
 #include <lemon/maps.h>
 
-// /// \file
-// /// \brief Maximum flow algorithms.
-// /// \ingroup galgs
+/// \file
+/// \brief Tight edge filter map.
+///
+/// Tight edge filter map is bool map on the edges of the graph
+/// which filters the edges which are not tight for a node-potential.
+/// It is used in the \ref sub_graph_adaptor_demo.cc file. 
+///
+/// \include tight_edge_filter_map.h
 
 namespace lemon {
 
-  /*! 
-    \brief A map for filtering the edge-set to those edges 
-    which are tight w.r.t. a node-potential and 
-    edge-distance.
-    
-    Let \f$ G=(V,A) \f$ be a directed graph (graph for short) and 
-    let \f$ \mathbb{F} \f$ be a number type. 
-    Given a distance function 
-    \f$ d:E\to\mathbb{F} \f$, 
-    \f$ \pi:V\to\mathbb{F} \f$ is said to be a potetial 
-    w.r.t. \f$ d \f$ 
-    if and only if 
-    \f$ \pi(v)\le d(uv)+\pi(u) \f$ holds for each edge \f$ uv\in E \f$ 
-    (or the reverse inequality holds for each edge). 
-    An edge is said to be tight if this inequality holds with equality, 
-    and the map returns \c true exactly for those edges. 
-    To avoid rounding errors, it is recommended to use this class with exact 
-    number types, e.g. with \c int.
-  */
+  /// \brief A map for filtering the edge-set to those edges 
+  /// which are tight w.r.t. a node-potential and 
+  /// edge-distance.
+  /// 
+  /// Let \f$ G=(V,A) \f$ be a directed graph (graph for short) and 
+  /// let \f$ \mathbb{F} \f$ be a number type. 
+  /// Given a distance function 
+  /// \f$ d:E\to\mathbb{F} \f$, 
+  /// \f$ \pi:V\to\mathbb{F} \f$ is said to be a potetial 
+  /// w.r.t. \f$ d \f$ 
+  /// if and only if 
+  /// \f$ \pi(v)\le d(uv)+\pi(u) \f$ holds for each edge \f$ uv\in E \f$ 
+  /// (or the reverse inequality holds for each edge). 
+  /// An edge is said to be tight if this inequality holds with equality, 
+  /// and the map returns \c true exactly for those edges. 
+  /// To avoid rounding errors, it is recommended to use this class with exact 
+  /// number types, e.g. with \c int.
   template<typename Graph, 
            typename NodePotentialMap, typename EdgeDistanceMap>
@@ -67 +70 @@
 } //namespace lemon
 
-#endif //LEMON_TIGHT_EDGE_FILTER_MAP_H
+#endif //DEMO_TIGHT_EDGE_FILTER_MAP_H