Ticket #179: 179-11-doc-group-631e955e3b94.patch
| File 179-11-doc-group-631e955e3b94.patch, 4.8 KB (added by , 15 years ago) |
|---|
-
doc/groups.dox
# HG changeset patch # User Peter Kovacs <kpeter@inf.elte.hu> # Date 1250063115 -7200 # Node ID 631e955e3b94f427e940f8271a5e844ecbcc0b24 # Parent 8642452f583c94b3f0bbb9a023ae7f402c11a196 Separate group for the min mean cycle classes (#179) diff --git a/doc/groups.dox b/doc/groups.dox
a b 391 391 */ 392 392 393 393 /** 394 @defgroup min_mean_cycle Minimum Mean Cycle Algorithms 395 @ingroup algs 396 \brief Algorithms for finding minimum mean cycles. 397 398 This group contains the algorithms for finding minimum mean cycles. 399 400 The \e minimum \e mean \e cycle \e problem is to find a directed cycle 401 of minimum mean length (cost) in a digraph. 402 The mean length of a cycle is the average length of its arcs, i.e. the 403 ratio between the total length of the cycle and the number of arcs on it. 404 405 This problem has an important connection to \e conservative \e length 406 \e functions, too. A length function on the arcs of a digraph is called 407 conservative if and only if there is no directed cycle of negative total 408 length. For an arbitrary length function, the negative of the minimum 409 cycle mean is the smallest \f$\epsilon\f$ value so that increasing the 410 arc lengths uniformly by \f$\epsilon\f$ results in a conservative length 411 function. 412 413 LEMON contains three algorithms for solving the minimum mean cycle problem: 414 - \ref Karp "Karp"'s original algorithm. 415 - \ref HartmannOrlin "Hartmann-Orlin"'s algorithm, which is an improved 416 version of Karp's algorithm. 417 - \ref Howard "Howard"'s policy iteration algorithm. 418 419 In practice, the Howard algorithm proved to be by far the most efficient 420 one, though the best known theoretical bound on its running time is 421 exponential. 422 Both Karp and HartmannOrlin algorithms run in time O(ne) and use space 423 O(n<sup>2</sup>+e), but the latter one is typically faster due to the 424 applied early termination scheme. 425 */ 426 427 /** 394 428 @defgroup graph_properties Connectivity and Other Graph Properties 395 429 @ingroup algs 396 430 \brief Algorithms for discovering the graph properties -
lemon/hartmann_orlin.h
diff --git a/lemon/hartmann_orlin.h b/lemon/hartmann_orlin.h
a b 19 19 #ifndef LEMON_HARTMANN_ORLIN_H 20 20 #define LEMON_HARTMANN_ORLIN_H 21 21 22 /// \ingroup shortest_path22 /// \ingroup min_mean_cycle 23 23 /// 24 24 /// \file 25 25 /// \brief Hartmann-Orlin's algorithm for finding a minimum mean cycle. … … 90 90 }; 91 91 92 92 93 /// \addtogroup shortest_path93 /// \addtogroup min_mean_cycle 94 94 /// @{ 95 95 96 96 /// \brief Implementation of the Hartmann-Orlin algorithm for finding … … 98 98 /// 99 99 /// This class implements the Hartmann-Orlin algorithm for finding 100 100 /// a directed cycle of minimum mean length (cost) in a digraph. 101 /// It is an improved version of \ref Karp "Karp 's original algorithm",101 /// It is an improved version of \ref Karp "Karp"'s original algorithm, 102 102 /// it applies an efficient early termination scheme. 103 /// It runs in time O(ne) and uses space O(n<sup>2</sup>+e). 103 104 /// 104 105 /// \tparam GR The type of the digraph the algorithm runs on. 105 106 /// \tparam LEN The type of the length map. The default -
lemon/howard.h
diff --git a/lemon/howard.h b/lemon/howard.h
a b 19 19 #ifndef LEMON_HOWARD_H 20 20 #define LEMON_HOWARD_H 21 21 22 /// \ingroup shortest_path22 /// \ingroup min_mean_cycle 23 23 /// 24 24 /// \file 25 25 /// \brief Howard's algorithm for finding a minimum mean cycle. … … 90 90 }; 91 91 92 92 93 /// \addtogroup shortest_path93 /// \addtogroup min_mean_cycle 94 94 /// @{ 95 95 96 96 /// \brief Implementation of Howard's algorithm for finding a minimum … … 98 98 /// 99 99 /// This class implements Howard's policy iteration algorithm for finding 100 100 /// a directed cycle of minimum mean length (cost) in a digraph. 101 /// This class provides the most efficient algorithm for the 102 /// minimum mean cycle problem, though the best known theoretical 103 /// bound on its running time is exponential. 101 104 /// 102 105 /// \tparam GR The type of the digraph the algorithm runs on. 103 106 /// \tparam LEN The type of the length map. The default -
lemon/karp.h
diff --git a/lemon/karp.h b/lemon/karp.h
a b 19 19 #ifndef LEMON_KARP_H 20 20 #define LEMON_KARP_H 21 21 22 /// \ingroup shortest_path22 /// \ingroup min_mean_cycle 23 23 /// 24 24 /// \file 25 25 /// \brief Karp's algorithm for finding a minimum mean cycle. … … 90 90 }; 91 91 92 92 93 /// \addtogroup shortest_path93 /// \addtogroup min_mean_cycle 94 94 /// @{ 95 95 96 96 /// \brief Implementation of Karp's algorithm for finding a minimum … … 98 98 /// 99 99 /// This class implements Karp's algorithm for finding a directed 100 100 /// cycle of minimum mean length (cost) in a digraph. 101 /// It runs in time O(ne) and uses space O(n<sup>2</sup>+e). 101 102 /// 102 103 /// \tparam GR The type of the digraph the algorithm runs on. 103 104 /// \tparam LEN The type of the length map. The default
