# HG changeset patch # User Peter Kovacs # Date 2010-03-18 00:30:25 # Node ID 38213abd29112e1321d5a80a3affa1c63fa633af # Parent 141f9c0db4a3892de5feca4ebdbc8776191567cd Small doc fixes and improvements (#359) diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ LEMON code without an explicit copyright notice is covered by the following copyright/license. -Copyright (C) 2003-2009 Egervary Jeno Kombinatorikus Optimalizalasi +Copyright (C) 2003-2010 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport (Egervary Combinatorial Optimization Research Group, EGRES). diff --git a/doc/groups.dox b/doc/groups.dox --- a/doc/groups.dox +++ b/doc/groups.dox @@ -263,14 +263,6 @@ */ /** -@defgroup matrices Matrices -@ingroup datas -\brief Two dimensional data storages implemented in LEMON. - -This group contains two dimensional data storages implemented in LEMON. -*/ - -/** @defgroup auxdat Auxiliary Data Structures @ingroup datas \brief Auxiliary data structures implemented in LEMON. @@ -472,19 +464,19 @@ function. LEMON contains three algorithms for solving the minimum mean cycle problem: -- \ref Karp "Karp"'s original algorithm \ref amo93networkflows, +- \ref KarpMmc Karp's original algorithm \ref amo93networkflows, \ref dasdan98minmeancycle. -- \ref HartmannOrlin "Hartmann-Orlin"'s algorithm, which is an improved +- \ref HartmannOrlinMmc Hartmann-Orlin's algorithm, which is an improved version of Karp's algorithm \ref dasdan98minmeancycle. -- \ref Howard "Howard"'s policy iteration algorithm +- \ref HowardMmc Howard's policy iteration algorithm \ref dasdan98minmeancycle. -In practice, the Howard algorithm proved to be by far the most efficient -one, though the best known theoretical bound on its running time is -exponential. -Both Karp and HartmannOrlin algorithms run in time O(ne) and use space -O(n2+e), but the latter one is typically faster due to the -applied early termination scheme. +In practice, the \ref HowardMmc "Howard" algorithm proved to be by far the +most efficient one, though the best known theoretical bound on its running +time is exponential. +Both \ref KarpMmc "Karp" and \ref HartmannOrlinMmc "Hartmann-Orlin" algorithms +run in time O(ne) and use space O(n2+e), but the latter one is +typically faster due to the applied early termination scheme. */ /** diff --git a/lemon/arg_parser.h b/lemon/arg_parser.h --- a/lemon/arg_parser.h +++ b/lemon/arg_parser.h @@ -35,12 +35,19 @@ namespace lemon { ///Exception used by ArgParser + + ///Exception used by ArgParser. + /// class ArgParserException : public Exception { public: + /// Reasons for failure + + /// Reasons for failure. + /// enum Reason { - HELP, /// --help option was given - UNKNOWN_OPT, /// Unknown option was given - INVALID_OPT /// Invalid combination of options + HELP, ///< --help option was given. + UNKNOWN_OPT, ///< Unknown option was given. + INVALID_OPT ///< Invalid combination of options. }; private: diff --git a/lemon/hartmann_orlin_mmc.h b/lemon/hartmann_orlin_mmc.h --- a/lemon/hartmann_orlin_mmc.h +++ b/lemon/hartmann_orlin_mmc.h @@ -38,7 +38,7 @@ /// Default traits class of HartmannOrlinMmc class. /// \tparam GR The type of the digraph. /// \tparam CM The type of the cost map. - /// It must conform to the \ref concepts::Rea_data "Rea_data" concept. + /// It must conform to the \ref concepts::ReadMap "ReadMap" concept. #ifdef DOXYGEN template #else @@ -99,7 +99,7 @@ /// This class implements the Hartmann-Orlin algorithm for finding /// a directed cycle of minimum mean cost in a digraph /// \ref amo93networkflows, \ref dasdan98minmeancycle. - /// It is an improved version of \ref Karp "Karp"'s original algorithm, + /// It is an improved version of \ref KarpMmc "Karp"'s original algorithm, /// it applies an efficient early termination scheme. /// It runs in time O(ne) and uses space O(n2+e). ///