Changeset 2491:b63ae56979ef in lemon-0.x

Timestamp:

10/09/07 19:11:42 (17 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Documentation for lemon tools

Files:

• doc/groups.dox (modified) (1 diff)
• doc/images/plane_tree.eps (added)
• doc/images/plane_tree.png (added)
• tools/dim_to_lgf.cc (modified) (2 diffs)
• tools/lgf-gen.cc (modified) (1 diff)

doc/groups.dox

@@ -494 +494 @@
 */
 
+/**
+@defgroup tools Standalone utility applications
+
+Some utility applications are listed here. 
+
+The standard compilation procedure (<tt>./configure;make</tt>) will compile
+them, as well. 
+
+*/
+

tools/dim_to_lgf.cc

@@ -17 +17 @@
  */
 
-///\ingroup demos
+///\ingroup tools
 ///\file
 ///\brief DIMACS to LGF converter.
@@ -24 +24 @@
 /// (LGF).
 ///
-/// \include dim_to_lgf.cc
+///\verbatim
+///Usage:
+///  ./tools/dim_to_lgf
+///     --mincostflow|-mcf|--maxflow|-mf|--shortestpath|-sp|--capacitated|-cap|--plain|-pl
+///     [--help|-h|-help] [--input|-i str] [--output|-o str] [--version|-v]
+///Where:
+///  --capacitated|-cap
+///     set the type of the graph to "capacitated" graph
+///  --help|-h|-help
+///     Print a short help message
+///  --input|-i str
+///     use FILE as input instead of standard input
+///  --maxflow|-mf
+///     set the type of the graph to "maxflow" graph
+///  --mincostflow|-mcf
+///     set the type of the graph to "mincostflow" graph
+///  --output|-o str
+///     use FILE as output instead of standard output
+///  --plain|-pl
+///     set the type of the graph to "plain" graph
+///  --shortestpath|-sp
+///     set the type of the graph to "shortestpath" graph
+///  --version|-v
+///     show version information
+///\endverbatim
+///
 
 #include <iostream>

tools/lgf-gen.cc

@@ -16 +16 @@
  *
  */
+///\ingroup tools
+///\file
+///\brief Special plane graph generator.
+///
+///Graph generator application for various types of plane graphs.
+///
+///\verbatim
+/// This program converts various DIMACS formats to the LEMON Graph Format
+/// (LGF).
+///
+/// Usage:
+///   ./tools/lgf-gen [-2con|-tree|-tsp|-tsp2|-dela] [-disc|-square|-gauss]
+///      [-rand|-seed int] [--help|-h|-help] [-area num] [-cities int] [-dir]
+///      [-eps] [-g int] [-n int] [prefix]
+/// Where:
+///   [prefix]
+///      Prefix of the output files. Default is 'lgf-gen-out'
+///   --help|-h|-help
+///      Print a short help message
+///   -2con
+///      Create a two connected planar graph
+///   -area num
+///      Full relative area of the cities (default is 1)
+///   -cities int
+///      Number of cities (default is 1)
+///   -dela
+///      Delaunay triangulation graph
+///   -dir
+///      Directed graph is generated (each edges are replaced by two directed ones)
+///   -disc
+///      Nodes are evenly distributed on a unit disc (default)
+///   -eps
+///      Also generate .eps output (prefix.eps)
+///   -g int
+///      Girth parameter (default is 10)
+///   -gauss
+///      Nodes are located according to a two-dim gauss distribution
+///   -n int
+///      Number of nodes (default is 100)
+///   -rand
+///      Use time seed for random number generator
+///   -seed int
+///      Random seed
+///   -square
+///      Nodes are evenly distributed on a unit square
+///   -tree
+///      Create a min. cost spanning tree
+///   -tsp
+///      Create a TSP tour
+///   -tsp2
+///      Create a TSP tour (tree based)
+///\endverbatim
+/// \image html plane_tree.png
+/// \image latex plane_tree.eps "Eucledian spanning tree" width=\textwidth
+///
+
 
 #include <lemon/list_graph.h>