1.1 --- a/doc/groups.dox Mon Feb 19 18:21:28 2007 +0000
1.2 +++ b/doc/groups.dox Mon Feb 19 18:56:11 2007 +0000
1.3 @@ -165,7 +165,6 @@
1.4
1.5 \image html edge_biconnected_components.png
1.6 \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
1.7 -
1.8 */
1.9
1.10 /**
1.11 @@ -213,11 +212,22 @@
1.12
1.13 */
1.14
1.15 +/**
1.16 +@defgroup lp_group
1.17 +@ingroup gen_opt_group
1.18 +\brief Lp and Mip solver interfaces for LEMON.
1.19 +
1.20 +This group describes Lp and Mip solver interfaces for LEMON. The
1.21 +various LP solvers could be used in the same manner with this
1.22 +interface.
1.23 +
1.24 +*/
1.25 +
1.26 /**
1.27 -\ingroup gen_opt_group
1.28 -@defgroup gen_opt_tools Various Tools for Optimization
1.29 -\brief This group adds some helper tools to general optimization
1.30 -framework implemented in LEMON.
1.31 +@defgroup lp_utils Tools for Lp and Mip solvers
1.32 +@ingroup lp_group
1.33 +\brief This group adds some helper tools to the Lp and Mip solvers
1.34 +implemented in LEMON.
1.35
1.36 This group adds some helper tools to general optimization framework
1.37 implemented in LEMON.
1.38 @@ -225,6 +235,14 @@
1.39 */
1.40
1.41 /**
1.42 +@defgroup metah Metaheuristics
1.43 +@ingroup gen_opt_group
1.44 +\brief Metaheuristics for LEMON library.
1.45 +
1.46 +This group contains some metaheuristic optimization tools.
1.47 +*/
1.48 +
1.49 +/**
1.50 @defgroup misc Miscellaneous Tools
1.51 Here you can find several useful tools for development,
1.52 debugging and testing.
1.53 @@ -254,7 +272,6 @@
1.54 Methods for reading and writing LEMON format. More about this
1.55 format you can find on the \ref graph-io-page "Graph Input-Output"
1.56 tutorial pages.
1.57 -
1.58 */
1.59
1.60 /**
2.1 --- a/lemon/lp.h Mon Feb 19 18:21:28 2007 +0000
2.2 +++ b/lemon/lp.h Mon Feb 19 18:56:11 2007 +0000
2.3 @@ -34,28 +34,28 @@
2.4
2.5 ///\file
2.6 ///\brief Defines a default LP solver
2.7 -///\ingroup gen_opt_group
2.8 +///\ingroup lp_group
2.9 namespace lemon {
2.10
2.11 #ifdef DOXYGEN
2.12 ///The default LP solver identifier
2.13
2.14 ///The default LP solver identifier.
2.15 - ///\ingroup gen_opt_group
2.16 + ///\ingroup lp_group
2.17 ///
2.18 ///Currently, the possible values are \c GLPK or \c CPLEX
2.19 #define DEFAULT_LP SOLVER
2.20 ///The default LP solver
2.21
2.22 ///The default LP solver.
2.23 - ///\ingroup gen_opt_group
2.24 + ///\ingroup lp_group
2.25 ///
2.26 ///Currently, it is either \c LpGlpk or \c LpCplex
2.27 typedef LpGlpk Lp;
2.28 ///The default LP solver identifier string
2.29
2.30 ///The default LP solver identifier string.
2.31 - ///\ingroup gen_opt_group
2.32 + ///\ingroup lp_group
2.33 ///
2.34 ///Currently, the possible values are "GLPK" or "CPLEX"
2.35 const char default_solver_name[]="SOLVER";
2.36 @@ -63,7 +63,7 @@
2.37 ///The default ILP solver.
2.38
2.39 ///The default ILP solver.
2.40 - ///\ingroup gen_opt_group
2.41 + ///\ingroup lp_group
2.42 ///
2.43 ///Currently, it is either \c LpGlpk or \c LpCplex
2.44 typedef MipGlpk Mip;
3.1 --- a/lemon/lp_base.h Mon Feb 19 18:21:28 2007 +0000
3.2 +++ b/lemon/lp_base.h Mon Feb 19 18:56:11 2007 +0000
3.3 @@ -34,13 +34,13 @@
3.4
3.5 ///\file
3.6 ///\brief The interface of the LP solver interface.
3.7 -///\ingroup gen_opt_group
3.8 +///\ingroup lp_group
3.9 namespace lemon {
3.10
3.11 ///Common base class for LP solvers
3.12
3.13 ///\todo Much more docs
3.14 - ///\ingroup gen_opt_group
3.15 + ///\ingroup lp_group
3.16 class LpSolverBase {
3.17
3.18 protected:
3.19 @@ -1376,9 +1376,10 @@
3.20 };
3.21
3.22
3.23 - ///Common base class for MIP solvers
3.24 - ///\todo Much more docs
3.25 - ///\ingroup gen_opt_group
3.26 + /// \ingroup lp_group
3.27 + ///
3.28 + /// \brief Common base class for MIP solvers
3.29 + /// \todo Much more docs
3.30 class MipSolverBase : virtual public LpSolverBase{
3.31 public:
3.32
4.1 --- a/lemon/lp_glpk.h Mon Feb 19 18:21:28 2007 +0000
4.2 +++ b/lemon/lp_glpk.h Mon Feb 19 18:56:11 2007 +0000
4.3 @@ -21,7 +21,7 @@
4.4
4.5 ///\file
4.6 ///\brief Header of the LEMON-GLPK lp solver interface.
4.7 -///\ingroup gen_opt_group
4.8 +///\ingroup lp_group
4.9
4.10 #include <lemon/lp_base.h>
4.11 extern "C" {
4.12 @@ -34,7 +34,7 @@
4.13 /// \brief Interface for the GLPK LP solver
4.14 ///
4.15 /// This class implements an interface for the GLPK LP solver.
4.16 - ///\ingroup gen_opt_group
4.17 + ///\ingroup lp_group
4.18 class LpGlpk : virtual public LpSolverBase {
4.19 protected:
4.20 LPX* lp;
5.1 --- a/lemon/lp_soplex.h Mon Feb 19 18:21:28 2007 +0000
5.2 +++ b/lemon/lp_soplex.h Mon Feb 19 18:56:11 2007 +0000
5.3 @@ -34,7 +34,7 @@
5.4
5.5 namespace lemon {
5.6
5.7 - /// \ingroup gen_opt_group
5.8 + /// \ingroup lp_group
5.9 ///
5.10 /// \brief Interface for the SOPLEX solver
5.11 ///
6.1 --- a/lemon/lp_utils.h Mon Feb 19 18:21:28 2007 +0000
6.2 +++ b/lemon/lp_utils.h Mon Feb 19 18:56:11 2007 +0000
6.3 @@ -30,7 +30,7 @@
6.4
6.5 namespace lemon {
6.6
6.7 - /// \ingroup gen_opt_tools
6.8 + /// \ingroup lp_utils
6.9 ///
6.10 /// \brief The map for the result of the lp variables.
6.11 ///
6.12 @@ -51,7 +51,17 @@
6.13 const LpSolverBase& lp;
6.14 };
6.15
6.16 - /// \ingroup gen_opt_tools
6.17 + /// \ingroup lp_utils
6.18 + ///
6.19 + /// \brief Returns an \ref LpResultMap class
6.20 + ///
6.21 + /// This function just returns an \ref LpResultMap class.
6.22 + /// \relates LpResultMap
6.23 + LpResultMap lpResultMap(const LpSolverBase& lp) {
6.24 + return LpResultMap(lp);
6.25 + }
6.26 +
6.27 + /// \ingroup lp_utils
6.28 ///
6.29 /// \brief The map for the name of the lp variables.
6.30 ///
6.31 @@ -72,7 +82,7 @@
6.32 const LpSolverBase& lp;
6.33 };
6.34
6.35 - /// \ingroup gen_opt_tools
6.36 + /// \ingroup lp_utils
6.37 ///
6.38 /// \brief Writeable map for the name of the lp variables.
6.39 ///
6.40 @@ -96,7 +106,7 @@
6.41 LpSolverBase& lp;
6.42 };
6.43
6.44 - /// \ingroup gen_opt_tools
6.45 + /// \ingroup lp_utils
6.46 ///
6.47 /// \brief Returns an \ref LpColNameMap class
6.48 ///
6.49 @@ -110,7 +120,7 @@
6.50 return LpColNameWriteMap(lp);
6.51 }
6.52
6.53 - /// \ingroup gen_opt_tools
6.54 + /// \ingroup lp_utils
6.55 ///
6.56 /// \brief Lp variable item reader for Lemon IO
6.57 ///
6.58 @@ -197,7 +207,7 @@
6.59
6.60 };
6.61
6.62 - /// \ingroup gen_opt_tools
6.63 + /// \ingroup lp_utils
6.64 ///
6.65 /// \brief Lp variable item writer for Lemon IO
6.66 ///
6.67 @@ -263,7 +273,7 @@
6.68
6.69 };
6.70
6.71 - /// \ingroup gen_opt_tools
6.72 + /// \ingroup lp_utils
6.73 ///
6.74 /// \brief Lp section reader for lemon IO
6.75 ///
6.76 @@ -743,7 +753,7 @@
6.77 };
6.78
6.79
6.80 - /// \ingroup gen_opt_tools
6.81 + /// \ingroup lp_utils
6.82 ///
6.83 /// \brief Lp section writer for lemon IO
6.84 ///
7.1 --- a/lemon/mip_cplex.h Mon Feb 19 18:21:28 2007 +0000
7.2 +++ b/lemon/mip_cplex.h Mon Feb 19 18:56:11 2007 +0000
7.3 @@ -21,7 +21,7 @@
7.4
7.5 ///\file
7.6 ///\brief Header of the LEMON-CPLEX mip solver interface.
7.7 -///\ingroup gen_opt_group
7.8 +///\ingroup lp_group
7.9
7.10
7.11 #include <lemon/lp_cplex.h>
7.12 @@ -31,7 +31,7 @@
7.13 /// \brief Interface for the CPLEX MIP solver
7.14 ///
7.15 /// This class implements an interface for the CPLEX MIP solver.
7.16 - ///\ingroup gen_opt_group
7.17 + ///\ingroup lp_group
7.18 class MipCplex : public MipSolverBase, public LpCplex{
7.19
7.20 public:
8.1 --- a/lemon/mip_glpk.h Mon Feb 19 18:21:28 2007 +0000
8.2 +++ b/lemon/mip_glpk.h Mon Feb 19 18:56:11 2007 +0000
8.3 @@ -21,7 +21,7 @@
8.4
8.5 ///\file
8.6 ///\brief Header of the LEMON-GLPK mip solver interface.
8.7 -///\ingroup gen_opt_group
8.8 +///\ingroup lp_group
8.9
8.10
8.11 #include <lemon/lp_glpk.h>
8.12 @@ -30,7 +30,7 @@
8.13 /// \brief Interface for the GLPK MIP solver
8.14 ///
8.15 /// This class implements an interface for the GLPK MIP solver.
8.16 - ///\ingroup gen_opt_group
8.17 + ///\ingroup lp_group
8.18 class MipGlpk : public MipSolverBase, public LpGlpk{
8.19
8.20 public:
9.1 --- a/lemon/simann.h Mon Feb 19 18:21:28 2007 +0000
9.2 +++ b/lemon/simann.h Mon Feb 19 18:56:11 2007 +0000
9.3 @@ -35,9 +35,6 @@
9.4
9.5 namespace lemon {
9.6
9.7 -/// \addtogroup experimental
9.8 -/// @{
9.9 -
9.10 class SimAnnBase;
9.11
9.12 /// \brief A base class for controllers.
9.13 @@ -172,6 +169,8 @@
9.14 virtual ~SimAnnBase() {}
9.15 };
9.16
9.17 + /// \ingroup metah
9.18 + ///
9.19 /// \brief Simulated annealing class.
9.20 class SimAnn : public SimAnnBase {
9.21 private:
9.22 @@ -375,8 +374,6 @@
9.23 virtual ~AdvancedController() {}
9.24 };
9.25
9.26 -/// @}
9.27 -
9.28 }
9.29
9.30 #endif
10.1 --- a/lemon/tabu_search.h Mon Feb 19 18:21:28 2007 +0000
10.2 +++ b/lemon/tabu_search.h Mon Feb 19 18:56:11 2007 +0000
10.3 @@ -20,7 +20,7 @@
10.4 #ifndef LEMON_TABU_SEARCH_H
10.5 #define LEMON_TABU_SEARCH_H
10.6
10.7 -/// \ingroup experimental
10.8 +/// \ingroup metah
10.9 /// \file
10.10 /// \brief TabuSearch algorithm.
10.11 ///
10.12 @@ -307,6 +307,8 @@
10.13
10.14
10.15
10.16 + /// \ingroup metah
10.17 + ///
10.18 /// \brief TabuSearch main class
10.19 ///
10.20 /// This class offers the implementation of tabu-search algorithm. The