# HG changeset patch # User deba # Date 1171911371 0 # Node ID ed6539025f27bdae163bfbbd2d3e8c119933036d # Parent 6ae1a97055a222d695a560514e9805477640a4e4 Some documentation changes diff -r 6ae1a97055a2 -r ed6539025f27 doc/groups.dox --- a/doc/groups.dox Mon Feb 19 18:21:28 2007 +0000 +++ b/doc/groups.dox Mon Feb 19 18:56:11 2007 +0000 @@ -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 @@ */ +/** +@defgroup lp_group +@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 -@defgroup gen_opt_tools Various Tools for Optimization -\brief This group adds some helper tools to general optimization -framework implemented in LEMON. +@defgroup lp_utils Tools for Lp and Mip solvers +@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 @@ */ /** +@defgroup metah Metaheuristics +@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. - */ /** diff -r 6ae1a97055a2 -r ed6539025f27 lemon/lp.h --- a/lemon/lp.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/lp.h Mon Feb 19 18:56:11 2007 +0000 @@ -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; diff -r 6ae1a97055a2 -r ed6539025f27 lemon/lp_base.h --- a/lemon/lp_base.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/lp_base.h Mon Feb 19 18:56:11 2007 +0000 @@ -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: diff -r 6ae1a97055a2 -r ed6539025f27 lemon/lp_glpk.h --- a/lemon/lp_glpk.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/lp_glpk.h Mon Feb 19 18:56:11 2007 +0000 @@ -21,7 +21,7 @@ ///\file ///\brief Header of the LEMON-GLPK lp solver interface. -///\ingroup gen_opt_group +///\ingroup lp_group #include 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; diff -r 6ae1a97055a2 -r ed6539025f27 lemon/lp_soplex.h --- a/lemon/lp_soplex.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/lp_soplex.h Mon Feb 19 18:56:11 2007 +0000 @@ -34,7 +34,7 @@ namespace lemon { - /// \ingroup gen_opt_group + /// \ingroup lp_group /// /// \brief Interface for the SOPLEX solver /// diff -r 6ae1a97055a2 -r ed6539025f27 lemon/lp_utils.h --- a/lemon/lp_utils.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/lp_utils.h Mon Feb 19 18:56:11 2007 +0000 @@ -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 /// diff -r 6ae1a97055a2 -r ed6539025f27 lemon/mip_cplex.h --- a/lemon/mip_cplex.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/mip_cplex.h Mon Feb 19 18:56:11 2007 +0000 @@ -21,7 +21,7 @@ ///\file ///\brief Header of the LEMON-CPLEX mip solver interface. -///\ingroup gen_opt_group +///\ingroup lp_group #include @@ -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: diff -r 6ae1a97055a2 -r ed6539025f27 lemon/mip_glpk.h --- a/lemon/mip_glpk.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/mip_glpk.h Mon Feb 19 18:56:11 2007 +0000 @@ -21,7 +21,7 @@ ///\file ///\brief Header of the LEMON-GLPK mip solver interface. -///\ingroup gen_opt_group +///\ingroup lp_group #include @@ -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: diff -r 6ae1a97055a2 -r ed6539025f27 lemon/simann.h --- a/lemon/simann.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/simann.h Mon Feb 19 18:56:11 2007 +0000 @@ -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 diff -r 6ae1a97055a2 -r ed6539025f27 lemon/tabu_search.h --- a/lemon/tabu_search.h Mon Feb 19 18:21:28 2007 +0000 +++ b/lemon/tabu_search.h Mon Feb 19 18:56:11 2007 +0000 @@ -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