Small doc fixes and improvements (#359)
authorPeter Kovacs <kpeter@inf.elte.hu>
Thu, 18 Mar 2010 00:30:25 +0100
changeset 87938213abd2911
parent 877 141f9c0db4a3
child 880 b89e46862dc2
Small doc fixes and improvements (#359)
LICENSE
doc/groups.dox
lemon/arg_parser.h
lemon/hartmann_orlin_mmc.h
     1.1 --- a/LICENSE	Sat Mar 06 14:35:12 2010 +0000
     1.2 +++ b/LICENSE	Thu Mar 18 00:30:25 2010 +0100
     1.3 @@ -1,7 +1,7 @@
     1.4  LEMON code without an explicit copyright notice is covered by the following
     1.5  copyright/license.
     1.6  
     1.7 -Copyright (C) 2003-2009 Egervary Jeno Kombinatorikus Optimalizalasi
     1.8 +Copyright (C) 2003-2010 Egervary Jeno Kombinatorikus Optimalizalasi
     1.9  Kutatocsoport (Egervary Combinatorial Optimization Research Group,
    1.10  EGRES).
    1.11  
     2.1 --- a/doc/groups.dox	Sat Mar 06 14:35:12 2010 +0000
     2.2 +++ b/doc/groups.dox	Thu Mar 18 00:30:25 2010 +0100
     2.3 @@ -263,14 +263,6 @@
     2.4  */
     2.5  
     2.6  /**
     2.7 -@defgroup matrices Matrices
     2.8 -@ingroup datas
     2.9 -\brief Two dimensional data storages implemented in LEMON.
    2.10 -
    2.11 -This group contains two dimensional data storages implemented in LEMON.
    2.12 -*/
    2.13 -
    2.14 -/**
    2.15  @defgroup auxdat Auxiliary Data Structures
    2.16  @ingroup datas
    2.17  \brief Auxiliary data structures implemented in LEMON.
    2.18 @@ -472,19 +464,19 @@
    2.19  function.
    2.20  
    2.21  LEMON contains three algorithms for solving the minimum mean cycle problem:
    2.22 -- \ref Karp "Karp"'s original algorithm \ref amo93networkflows,
    2.23 +- \ref KarpMmc Karp's original algorithm \ref amo93networkflows,
    2.24    \ref dasdan98minmeancycle.
    2.25 -- \ref HartmannOrlin "Hartmann-Orlin"'s algorithm, which is an improved
    2.26 +- \ref HartmannOrlinMmc Hartmann-Orlin's algorithm, which is an improved
    2.27    version of Karp's algorithm \ref dasdan98minmeancycle.
    2.28 -- \ref Howard "Howard"'s policy iteration algorithm
    2.29 +- \ref HowardMmc Howard's policy iteration algorithm
    2.30    \ref dasdan98minmeancycle.
    2.31  
    2.32 -In practice, the Howard algorithm proved to be by far the most efficient
    2.33 -one, though the best known theoretical bound on its running time is
    2.34 -exponential.
    2.35 -Both Karp and HartmannOrlin algorithms run in time O(ne) and use space
    2.36 -O(n<sup>2</sup>+e), but the latter one is typically faster due to the
    2.37 -applied early termination scheme.
    2.38 +In practice, the \ref HowardMmc "Howard" algorithm proved to be by far the
    2.39 +most efficient one, though the best known theoretical bound on its running
    2.40 +time is exponential.
    2.41 +Both \ref KarpMmc "Karp" and \ref HartmannOrlinMmc "Hartmann-Orlin" algorithms
    2.42 +run in time O(ne) and use space O(n<sup>2</sup>+e), but the latter one is
    2.43 +typically faster due to the applied early termination scheme.
    2.44  */
    2.45  
    2.46  /**
     3.1 --- a/lemon/arg_parser.h	Sat Mar 06 14:35:12 2010 +0000
     3.2 +++ b/lemon/arg_parser.h	Thu Mar 18 00:30:25 2010 +0100
     3.3 @@ -35,12 +35,19 @@
     3.4  namespace lemon {
     3.5  
     3.6    ///Exception used by ArgParser
     3.7 +
     3.8 +  ///Exception used by ArgParser.
     3.9 +  ///
    3.10    class ArgParserException : public Exception {
    3.11    public:
    3.12 +    /// Reasons for failure
    3.13 +
    3.14 +    /// Reasons for failure.
    3.15 +    ///
    3.16      enum Reason {
    3.17 -      HELP,         /// <tt>--help</tt> option was given
    3.18 -      UNKNOWN_OPT,  /// Unknown option was given
    3.19 -      INVALID_OPT   /// Invalid combination of options
    3.20 +      HELP,         ///< <tt>--help</tt> option was given.
    3.21 +      UNKNOWN_OPT,  ///< Unknown option was given.
    3.22 +      INVALID_OPT   ///< Invalid combination of options.
    3.23      };
    3.24  
    3.25    private:
     4.1 --- a/lemon/hartmann_orlin_mmc.h	Sat Mar 06 14:35:12 2010 +0000
     4.2 +++ b/lemon/hartmann_orlin_mmc.h	Thu Mar 18 00:30:25 2010 +0100
     4.3 @@ -38,7 +38,7 @@
     4.4    /// Default traits class of HartmannOrlinMmc class.
     4.5    /// \tparam GR The type of the digraph.
     4.6    /// \tparam CM The type of the cost map.
     4.7 -  /// It must conform to the \ref concepts::Rea_data "Rea_data" concept.
     4.8 +  /// It must conform to the \ref concepts::ReadMap "ReadMap" concept.
     4.9  #ifdef DOXYGEN
    4.10    template <typename GR, typename CM>
    4.11  #else
    4.12 @@ -99,7 +99,7 @@
    4.13    /// This class implements the Hartmann-Orlin algorithm for finding
    4.14    /// a directed cycle of minimum mean cost in a digraph
    4.15    /// \ref amo93networkflows, \ref dasdan98minmeancycle.
    4.16 -  /// It is an improved version of \ref Karp "Karp"'s original algorithm,
    4.17 +  /// It is an improved version of \ref KarpMmc "Karp"'s original algorithm,
    4.18    /// it applies an efficient early termination scheme.
    4.19    /// It runs in time O(ne) and uses space O(n<sup>2</sup>+e).
    4.20    ///