[Lemon-commits] deba: r3185 - in hugo/trunk: doc lemon

Lemon SVN svn at lemon.cs.elte.hu
Mon Feb 19 19:56:12 CET 2007 

Author: deba
Date: Mon Feb 19 19:56:11 2007
New Revision: 3185

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/lemon/lp.h
   hugo/trunk/lemon/lp_base.h
   hugo/trunk/lemon/lp_glpk.h
   hugo/trunk/lemon/lp_soplex.h
   hugo/trunk/lemon/lp_utils.h
   hugo/trunk/lemon/mip_cplex.h
   hugo/trunk/lemon/mip_glpk.h
   hugo/trunk/lemon/simann.h
   hugo/trunk/lemon/tabu_search.h

Log:
Some documentation changes



Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Mon Feb 19 19:56:11 2007
@@ -165,7 +165,6 @@
 
 \image html edge_biconnected_components.png
 \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
-
 */
 
 /**
@@ -213,11 +212,22 @@
 
 */
 
+/**
+ at defgroup lp_group
+ at ingroup gen_opt_group
+\brief Lp and Mip solver interfaces for LEMON.
+
+This group describes Lp and Mip solver interfaces for LEMON. The
+various LP solvers could be used in the same manner with this
+interface.
+
+*/
+
 /** 
-\ingroup gen_opt_group 
- at defgroup gen_opt_tools Various Tools for Optimization 
-\brief This group adds some helper tools to general optimization
-framework implemented in LEMON.
+ at defgroup lp_utils Tools for Lp and Mip solvers 
+ at ingroup lp_group
+\brief This group adds some helper tools to the Lp and Mip solvers
+implemented in LEMON.
 
 This group adds some helper tools to general optimization framework
 implemented in LEMON.
@@ -225,6 +235,14 @@
 */
 
 /**
+ at defgroup metah Metaheuristics
+ at ingroup gen_opt_group
+\brief Metaheuristics for LEMON library.
+
+This group contains some metaheuristic optimization tools.
+*/
+
+/**
 @defgroup misc Miscellaneous Tools
 Here you can find several useful tools for development,
 debugging and testing.
@@ -254,7 +272,6 @@
 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.
-
 */
 
 /**

Modified: hugo/trunk/lemon/lp.h
==============================================================================
--- hugo/trunk/lemon/lp.h	(original)
+++ hugo/trunk/lemon/lp.h	Mon Feb 19 19:56:11 2007
@@ -34,28 +34,28 @@
 
 ///\file
 ///\brief Defines a default LP solver
-///\ingroup gen_opt_group
+///\ingroup lp_group
 namespace lemon {
 
 #ifdef DOXYGEN
   ///The default LP solver identifier
 
   ///The default LP solver identifier.
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   ///
   ///Currently, the possible values are \c GLPK or \c CPLEX
 #define DEFAULT_LP SOLVER
   ///The default LP solver
 
   ///The default LP solver.
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   ///
   ///Currently, it is either \c LpGlpk or \c LpCplex
   typedef LpGlpk Lp;
   ///The default LP solver identifier string
 
   ///The default LP solver identifier string.
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   ///
   ///Currently, the possible values are "GLPK" or "CPLEX"
   const char default_solver_name[]="SOLVER";  
@@ -63,7 +63,7 @@
   ///The default ILP solver.
 
   ///The default ILP solver.
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   ///
   ///Currently, it is either \c LpGlpk or \c LpCplex
   typedef MipGlpk Mip;

Modified: hugo/trunk/lemon/lp_base.h
==============================================================================
--- hugo/trunk/lemon/lp_base.h	(original)
+++ hugo/trunk/lemon/lp_base.h	Mon Feb 19 19:56:11 2007
@@ -34,13 +34,13 @@
 
 ///\file
 ///\brief The interface of the LP solver interface.
-///\ingroup gen_opt_group
+///\ingroup lp_group
 namespace lemon {
 
   ///Common base class for LP solvers
   
   ///\todo Much more docs
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   class LpSolverBase {
 
   protected:
@@ -1376,9 +1376,10 @@
   };  
 
 
-  ///Common base class for MIP solvers
-  ///\todo Much more docs
-  ///\ingroup gen_opt_group
+  /// \ingroup lp_group
+  ///
+  /// \brief Common base class for MIP solvers
+  /// \todo Much more docs
   class MipSolverBase : virtual public LpSolverBase{
   public:
 

Modified: hugo/trunk/lemon/lp_glpk.h
==============================================================================
--- hugo/trunk/lemon/lp_glpk.h	(original)
+++ hugo/trunk/lemon/lp_glpk.h	Mon Feb 19 19:56:11 2007
@@ -21,7 +21,7 @@
 
 ///\file
 ///\brief Header of the LEMON-GLPK lp solver interface.
-///\ingroup gen_opt_group
+///\ingroup lp_group
 
 #include <lemon/lp_base.h>
 extern "C" {
@@ -34,7 +34,7 @@
   /// \brief Interface for the GLPK LP solver
   /// 
   /// This class implements an interface for the GLPK LP solver.
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   class LpGlpk : virtual public LpSolverBase {
   protected:
     LPX* lp;

Modified: hugo/trunk/lemon/lp_soplex.h
==============================================================================
--- hugo/trunk/lemon/lp_soplex.h	(original)
+++ hugo/trunk/lemon/lp_soplex.h	Mon Feb 19 19:56:11 2007
@@ -34,7 +34,7 @@
 
 namespace lemon {
 
-  /// \ingroup gen_opt_group
+  /// \ingroup lp_group
   ///
   /// \brief Interface for the SOPLEX solver
   /// 

Modified: hugo/trunk/lemon/lp_utils.h
==============================================================================
--- hugo/trunk/lemon/lp_utils.h	(original)
+++ hugo/trunk/lemon/lp_utils.h	Mon Feb 19 19:56:11 2007
@@ -30,7 +30,7 @@
 
 namespace lemon {
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief The map for the result of the lp variables.
   ///
@@ -51,7 +51,17 @@
     const LpSolverBase& lp;
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
+  ///
+  /// \brief Returns an \ref LpResultMap class
+  ///
+  /// This function just returns an \ref LpResultMap class.
+  /// \relates LpResultMap
+  LpResultMap lpResultMap(const LpSolverBase& lp) {
+    return LpResultMap(lp);
+  }
+
+  /// \ingroup lp_utils
   ///
   /// \brief The map for the name of the lp variables.
   ///
@@ -72,7 +82,7 @@
     const LpSolverBase& lp;
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Writeable map for the name of the lp variables.
   ///
@@ -96,7 +106,7 @@
     LpSolverBase& lp;
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Returns an \ref LpColNameMap class
   ///
@@ -110,7 +120,7 @@
     return LpColNameWriteMap(lp);
   }
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp variable item reader for Lemon IO
   ///
@@ -197,7 +207,7 @@
 
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp variable item writer for Lemon IO
   ///
@@ -263,7 +273,7 @@
 
   };
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp section reader for lemon IO
   ///
@@ -743,7 +753,7 @@
   };
 
 
-  /// \ingroup gen_opt_tools
+  /// \ingroup lp_utils
   ///
   /// \brief Lp section writer for lemon IO
   ///

Modified: hugo/trunk/lemon/mip_cplex.h
==============================================================================
--- hugo/trunk/lemon/mip_cplex.h	(original)
+++ hugo/trunk/lemon/mip_cplex.h	Mon Feb 19 19:56:11 2007
@@ -21,7 +21,7 @@
 
 ///\file
 ///\brief Header of the LEMON-CPLEX mip solver interface.
-///\ingroup gen_opt_group
+///\ingroup lp_group
 
 
 #include <lemon/lp_cplex.h>
@@ -31,7 +31,7 @@
   /// \brief Interface for the CPLEX MIP solver
   /// 
   /// This class implements an interface for the CPLEX MIP solver.
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   class MipCplex : public MipSolverBase, public LpCplex{
     
   public:

Modified: hugo/trunk/lemon/mip_glpk.h
==============================================================================
--- hugo/trunk/lemon/mip_glpk.h	(original)
+++ hugo/trunk/lemon/mip_glpk.h	Mon Feb 19 19:56:11 2007
@@ -21,7 +21,7 @@
 
 ///\file
 ///\brief Header of the LEMON-GLPK mip solver interface.
-///\ingroup gen_opt_group
+///\ingroup lp_group
 
 
 #include <lemon/lp_glpk.h>
@@ -30,7 +30,7 @@
   /// \brief Interface for the GLPK MIP solver
   /// 
   /// This class implements an interface for the GLPK MIP solver.
-  ///\ingroup gen_opt_group
+  ///\ingroup lp_group
   class MipGlpk : public MipSolverBase, public LpGlpk{
   
   public:

Modified: hugo/trunk/lemon/simann.h
==============================================================================
--- hugo/trunk/lemon/simann.h	(original)
+++ hugo/trunk/lemon/simann.h	Mon Feb 19 19:56:11 2007
@@ -35,9 +35,6 @@
 
 namespace lemon {
 
-/// \addtogroup experimental
-/// @{
-
   class SimAnnBase;
 
   /// \brief A base class for controllers.
@@ -172,6 +169,8 @@
     virtual ~SimAnnBase() {}
   };
 
+  /// \ingroup metah
+  ///
   /// \brief Simulated annealing class.
   class SimAnn : public SimAnnBase {
   private:
@@ -375,8 +374,6 @@
     virtual ~AdvancedController() {}
   };
 
-/// @}
-
 }
 
 #endif

Modified: hugo/trunk/lemon/tabu_search.h
==============================================================================
--- hugo/trunk/lemon/tabu_search.h	(original)
+++ hugo/trunk/lemon/tabu_search.h	Mon Feb 19 19:56:11 2007
@@ -20,7 +20,7 @@
 #ifndef LEMON_TABU_SEARCH_H
 #define LEMON_TABU_SEARCH_H
 
-/// \ingroup experimental
+/// \ingroup metah
 /// \file
 /// \brief TabuSearch algorithm.
 ///
@@ -307,6 +307,8 @@
 
 
 
+  /// \ingroup metah
+  ///
   /// \brief TabuSearch main class
   ///
   /// This class offers the implementation of tabu-search algorithm. The

More information about the Lemon-commits mailing list