Changeset 1583:2b329fd595ef in lemon-0.x

Timestamp:

07/22/05 17:15:29 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Documented some more demo programs.

Location:

demo

Files:

• dijkstra_demo.cc (modified) (2 diffs)
• hello_lemon.cc (modified) (1 diff)
• kruskal_demo.cc (modified) (1 diff)
• lp_maxflow_demo.cc (modified) (1 diff)
• reader_writer_demo.cc (modified) (2 diffs)
• sub_graph_adaptor_demo.cc (modified) (4 diffs)

demo/dijkstra_demo.cc

@@ +1 @@
+/* -*- C++ -*-
+ * demo/lp_maxflow_demo.cc - Part of LEMON, a generic C++ optimization library
+ *
+ * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
+ * (Egervary Research Group on Combinatorial Optimization, EGRES).
+ *
+ * Permission to use, modify and distribute this software is granted
+ * provided that this copyright notice appears in all copies. For
+ * precise terms see the accompanying LICENSE file.
+ *
+ * This software is provided "AS IS" with no warranty of any kind,
+ * express or implied, and with no claim as to its suitability for any
+ * purpose.
+ *
+ */
+
+///\ingroup demos
+///\file
+///\brief Demonstrating LEMON implementation of the Dijkstra algorithm
+///
+/// Dijkstra's algorithm computes shortest paths between two nodes in
+/// a graph with edge lengths. Here we only show some of the
+/// facilities supplied by our implementation: for the detailed
+/// documentation of the LEMON Dijkstra class read \ref lemon::Dijkstra "this".
+
 #include <iostream>
 
@@ -52 +77 @@
     std::cout << "The id of s is " << g.id(s)<< ", the id of t is " << g.id(t)<<"."<<std::endl;
 
-    std::cout << "Dijkstra algorithm test..." << std::endl;
+    std::cout << "Dijkstra algorithm demo..." << std::endl;
 
 

demo/hello_lemon.cc

@@ +1 @@
+/* -*- C++ -*-
+ * demo/lp_maxflow_demo.cc - Part of LEMON, a generic C++ optimization library
+ *
+ * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
+ * (Egervary Research Group on Combinatorial Optimization, EGRES).
+ *
+ * Permission to use, modify and distribute this software is granted
+ * provided that this copyright notice appears in all copies. For
+ * precise terms see the accompanying LICENSE file.
+ *
+ * This software is provided "AS IS" with no warranty of any kind,
+ * express or implied, and with no claim as to its suitability for any
+ * purpose.
+ *
+ */
+
+///\ingroup demos
+///\file
+///\brief LEMON style "Hello World!" program
+///
+/// This program is intended to be a "Hello World!" program that shows
+/// the very basic notions of the LEMON library: \ref graphs "graphs" and
+/// \ref maps-page "maps". Click on the links to read more about these.
+
 #include <iostream>
 #include <lemon/list_graph.h>

demo/kruskal_demo.cc

@@ -19 +19 @@
 ///\brief Minimum weight spanning tree by Kruskal algorithm (demo).
 ///
-///This demo program shows how to find a minimum weight spannin tree
-///of a graph by using the Kruskal algorithm. 
+/// This demo program shows how to find a minimum weight spanning tree
+/// in a graph by using the Kruskal algorithm. 
 
 #include <iostream>

demo/lp_maxflow_demo.cc

@@ -19 +19 @@
 ///\brief Max flow problem solved with an LP solver (demo).
 ///
-///This demo program shows how to solve a maximum (or maximal) flow
-///problem using the LEMON LP solver interface. We would like to lay
-///the emphasis on the simplicity of the way one can formulate the LP
-///constraints with LEMON that arise in graph theory.
+/// This demo program shows how to solve a maximum (or maximal) flow
+/// problem using the LEMON LP solver interface. We would like to lay
+/// the emphasis on the simplicity of the way one can formulate LP
+/// constraints that arise in graph theory in our library LEMON .
 
 #ifdef HAVE_CONFIG_H

demo/reader_writer_demo.cc

@@ +1 @@
+/* -*- C++ -*-
+ * demo/lp_maxflow_demo.cc - Part of LEMON, a generic C++ optimization library
+ *
+ * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
+ * (Egervary Research Group on Combinatorial Optimization, EGRES).
+ *
+ * Permission to use, modify and distribute this software is granted
+ * provided that this copyright notice appears in all copies. For
+ * precise terms see the accompanying LICENSE file.
+ *
+ * This software is provided "AS IS" with no warranty of any kind,
+ * express or implied, and with no claim as to its suitability for any
+ * purpose.
+ *
+ */
+
+///\ingroup demos
+///\file
+///\brief Demonstrating graph input and output
+///
+/// This simple demo program gives an example of how to read and write
+/// a graph and additional maps (on the nodes or the edges) from/to a
+/// stream. 
+
+
 #include <iostream>
 #include <lemon/smart_graph.h>
@@ -19 +44 @@
 
     std::cout << "Hello! We have read a graph from file " << filename<< 
-      " and some maps on it: now we write this to the standard output!" << 
+      " and some maps on it:\n now we write it to the standard output!" << 
       std::endl;
 

demo/sub_graph_adaptor_demo.cc

@@ -1 @@
-// -*- c++ -*-
+/* -*- C++ -*-
+ * demo/lp_maxflow_demo.cc - Part of LEMON, a generic C++ optimization library
+ *
+ * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
+ * (Egervary Research Group on Combinatorial Optimization, EGRES).
+ *
+ * Permission to use, modify and distribute this software is granted
+ * provided that this copyright notice appears in all copies. For
+ * precise terms see the accompanying LICENSE file.
+ *
+ * This software is provided "AS IS" with no warranty of any kind,
+ * express or implied, and with no claim as to its suitability for any
+ * purpose.
+ *
+ */
+
+///\ingroup demos
+///\file
+///\brief Computing maximum number of edge-disjoint shortest paths
+///
+/// This program computes a maximum number of edge-disjoint shortest paths
+/// between nodes \c s and \c t.
+
 
 // Use a DIMACS max flow file as input.
 // sub_graph_adaptor_demo < dimacs_max_flow_file
-// This program computes a maximum number of edge-disjoint shortest paths
-// between s and t.
+// Modified to eat lemon graph format! 
+
 
 #include <iostream>
@@ -17 +39 @@
 #include <tight_edge_filter_map.h>
 
+#include <lemon/graph_reader.h>
 
-
-//#include <lemon/graph_reader.h>
-//#include <lemon/graph_writer.h>
 
 using namespace lemon;
@@ -31 +51 @@
   if(argc<2)
   {
-      std::cerr << "USAGE: sub_graph_adaptor_demo input_file.dim" << std::endl;
-      std::cerr << "The file 'input_file.dim' has to contain a max flow instance in DIMACS format (e.g. sub_graph_adaptor_demo.dim is such a file)." << std::endl;
+      std::cerr << "USAGE: sub_graph_adaptor_demo input_file.lgf" << std::endl;
+      std::cerr << "The file 'input_file.lgf' has to contain a max flow "
+                << "instance in \n LEMON format "
+                << "(e.g. sub_gad_input.lgf is such a file)." 
+                << std::endl;
       return 0;
   }
@@ -52 +75 @@
   LengthMap length(g);
 
-  readDimacs(is, g, length, s, t);
+  //readDimacs(is, g, length, s, t);
 
-//     GraphWriter<SmartGraph> writer(std::cout, g);
-//     writer.writeEdgeMap("length", length);
-//     writer.writeNode("source",s);
-//     writer.writeNode("target",t);
-//     writer.run();
 
-//   GraphReader<ListGraph> reader(is,g);
-//   reader.readNode("source",s).readNode("target",t)
-//     .readEdgeMap("length",length).run();
+  GraphReader<SmartGraph> reader(is,g);
+  reader.readNode("source",s).readNode("target",t)
+    .readEdgeMap("length",length).run();
 
   cout << "edges with lengths (of form id, source--length->target): " << endl;