gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Various doc improvements (#406)
0 8 0
default
8 files changed with 32 insertions and 28 deletions:
↑ Collapse diff ↑
Ignore white space 6 line context
... ...
@@ -97,12 +97,12 @@
97 97
\endcode
98 98

	
99 99
\subsection pri-loc-var Private member variables
100 100

	
101
Private member variables should start with underscore
101
Private member variables should start with underscore.
102 102

	
103 103
\code
104
_start_with_underscores
104
_start_with_underscore
105 105
\endcode
106 106

	
107 107
\subsection cs-excep Exceptions
108 108

	
Ignore white space 6 line context
... ...
@@ -405,12 +405,12 @@
405 405
   shortest path method \ref edmondskarp72theoretical.
406 406
 - \ref CycleCanceling Cycle-Canceling algorithms, two of which are
407 407
   strongly polynomial \ref klein67primal, \ref goldberg89cyclecanceling.
408 408

	
409
In general NetworkSimplex is the most efficient implementation,
410
but in special cases other algorithms could be faster.
409
In general, \ref NetworkSimplex and \ref CostScaling are the most efficient
410
implementations, but the other two algorithms could be faster in special cases.
411 411
For example, if the total supply and/or capacities are rather small,
412
CapacityScaling is usually the fastest algorithm (without effective scaling).
412
\ref CapacityScaling is usually the fastest algorithm (without effective scaling).
413 413
*/
414 414

	
415 415
/**
416 416
@defgroup min_cut Minimum Cut Algorithms
... ...
@@ -470,9 +470,9 @@
470 470
  version of Karp's algorithm \ref dasdan98minmeancycle.
471 471
- \ref HowardMmc Howard's policy iteration algorithm
472 472
  \ref dasdan98minmeancycle.
473 473

	
474
In practice, the \ref HowardMmc "Howard" algorithm proved to be by far the
474
In practice, the \ref HowardMmc "Howard" algorithm turned out to be by far the
475 475
most efficient one, though the best known theoretical bound on its running
476 476
time is exponential.
477 477
Both \ref KarpMmc "Karp" and \ref HartmannOrlinMmc "Hartmann-Orlin" algorithms
478 478
run in time O(ne) and use space O(n<sup>2</sup>+e), but the latter one is
... ...
@@ -538,9 +538,9 @@
538 538
\image latex connected_components.eps "Connected components" width=\textwidth
539 539
*/
540 540

	
541 541
/**
542
@defgroup planar Planarity Embedding and Drawing
542
@defgroup planar Planar Embedding and Drawing
543 543
@ingroup algs
544 544
\brief Algorithms for planarity checking, embedding and drawing
545 545

	
546 546
This group contains the algorithms for planarity checking,
Ignore white space 6 line context
... ...
@@ -87,10 +87,10 @@
87 87
  /// consider to use the named template parameters instead.
88 88
  ///
89 89
  /// \warning Both number types must be signed and all input data must
90 90
  /// be integer.
91
  /// \warning This algorithm does not support negative costs for such
92
  /// arcs that have infinite upper bound.
91
  /// \warning This algorithm does not support negative costs for
92
  /// arcs having infinite upper bound.
93 93
#ifdef DOXYGEN
94 94
  template <typename GR, typename V, typename C, typename TR>
95 95
#else
96 96
  template < typename GR, typename V = int, typename C = V,
... ...
@@ -421,9 +421,9 @@
421 421
    /// If neither this function nor \ref supplyMap() is used before
422 422
    /// calling \ref run(), the supply of each node will be set to zero.
423 423
    ///
424 424
    /// Using this function has the same effect as using \ref supplyMap()
425
    /// with such a map in which \c k is assigned to \c s, \c -k is
425
    /// with a map in which \c k is assigned to \c s, \c -k is
426 426
    /// assigned to \c t and all other nodes have zero supply value.
427 427
    ///
428 428
    /// \param s The source node.
429 429
    /// \param t The target node.
Ignore white space 6 line context
... ...
@@ -446,9 +446,9 @@
446 446
    };
447 447

	
448 448
  }
449 449

	
450
  /// Check whether a graph is undirected.
450
  /// \brief Check whether a graph is undirected.
451 451
  ///
452 452
  /// This function returns \c true if the given graph is undirected.
453 453
#ifdef DOXYGEN
454 454
  template <typename GR>
Ignore white space 6 line context
... ...
@@ -96,8 +96,11 @@
96 96
  /// It is a highly efficient primal-dual solution method, which
97 97
  /// can be viewed as the generalization of the \ref Preflow
98 98
  /// "preflow push-relabel" algorithm for the maximum flow problem.
99 99
  ///
100
  /// In general, \ref NetworkSimplex and \ref CostScaling are the fastest
101
  /// implementations available in LEMON for this problem.
102
  ///
100 103
  /// Most of the parameters of the problem (except for the digraph)
101 104
  /// can be given using separate functions, and the algorithm can be
102 105
  /// executed using the \ref run() function. If some parameters are not
103 106
  /// specified, then default values will be used.
... ...
@@ -114,10 +117,10 @@
114 117
  /// consider to use the named template parameters instead.
115 118
  ///
116 119
  /// \warning Both number types must be signed and all input data must
117 120
  /// be integer.
118
  /// \warning This algorithm does not support negative costs for such
119
  /// arcs that have infinite upper bound.
121
  /// \warning This algorithm does not support negative costs for
122
  /// arcs having infinite upper bound.
120 123
  ///
121 124
  /// \note %CostScaling provides three different internal methods,
122 125
  /// from which the most efficient one is used by default.
123 126
  /// For more information, see \ref Method.
... ...
@@ -177,9 +180,9 @@
177 180
    /// \ref CostScaling provides three internal methods that differ mainly
178 181
    /// in their base operations, which are used in conjunction with the
179 182
    /// relabel operation.
180 183
    /// By default, the so called \ref PARTIAL_AUGMENT
181
    /// "Partial Augment-Relabel" method is used, which proved to be
184
    /// "Partial Augment-Relabel" method is used, which turned out to be
182 185
    /// the most efficient and the most robust on various test inputs.
183 186
    /// However, the other methods can be selected using the \ref run()
184 187
    /// function with the proper parameter.
185 188
    enum Method {
... ...
@@ -446,9 +449,9 @@
446 449
    /// If neither this function nor \ref supplyMap() is used before
447 450
    /// calling \ref run(), the supply of each node will be set to zero.
448 451
    ///
449 452
    /// Using this function has the same effect as using \ref supplyMap()
450
    /// with such a map in which \c k is assigned to \c s, \c -k is
453
    /// with a map in which \c k is assigned to \c s, \c -k is
451 454
    /// assigned to \c t and all other nodes have zero supply value.
452 455
    ///
453 456
    /// \param s The source node.
454 457
    /// \param t The target node.
Ignore white space 6 line context
... ...
@@ -66,10 +66,10 @@
66 66
  /// algorithm. By default, it is the same as \c V.
67 67
  ///
68 68
  /// \warning Both number types must be signed and all input data must
69 69
  /// be integer.
70
  /// \warning This algorithm does not support negative costs for such
71
  /// arcs that have infinite upper bound.
70
  /// \warning This algorithm does not support negative costs for
71
  /// arcs having infinite upper bound.
72 72
  ///
73 73
  /// \note For more information about the three available methods,
74 74
  /// see \ref Method.
75 75
#ifdef DOXYGEN
... ...
@@ -115,10 +115,9 @@
115 115
    /// for the \ref run() function.
116 116
    ///
117 117
    /// \ref CycleCanceling provides three different cycle-canceling
118 118
    /// methods. By default, \ref CANCEL_AND_TIGHTEN "Cancel and Tighten"
119
    /// is used, which proved to be the most efficient and the most robust
120
    /// on various test inputs.
119
    /// is used, which is by far the most efficient and the most robust.
121 120
    /// However, the other methods can be selected using the \ref run()
122 121
    /// function with the proper parameter.
123 122
    enum Method {
124 123
      /// A simple cycle-canceling method, which uses the
... ...
@@ -348,9 +347,9 @@
348 347
    /// If neither this function nor \ref supplyMap() is used before
349 348
    /// calling \ref run(), the supply of each node will be set to zero.
350 349
    ///
351 350
    /// Using this function has the same effect as using \ref supplyMap()
352
    /// with such a map in which \c k is assigned to \c s, \c -k is
351
    /// with a map in which \c k is assigned to \c s, \c -k is
353 352
    /// assigned to \c t and all other nodes have zero supply value.
354 353
    ///
355 354
    /// \param s The source node.
356 355
    /// \param t The target node.
Ignore white space 8 line context
... ...
@@ -35,9 +35,9 @@
35 35
namespace lemon {
36 36

	
37 37
  ///Euler tour iterator for digraphs.
38 38

	
39
  /// \ingroup graph_prop
39
  /// \ingroup graph_properties
40 40
  ///This iterator provides an Euler tour (Eulerian circuit) of a \e directed
41 41
  ///graph (if there exists) and it converts to the \c Arc type of the digraph.
42 42
  ///
43 43
  ///For example, if the given digraph has an Euler tour (i.e it has only one
Ignore white space 6 line context
... ...
@@ -46,12 +46,12 @@
46 46
  /// This algorithm is a highly efficient specialized version of the
47 47
  /// linear programming simplex method directly for the minimum cost
48 48
  /// flow problem.
49 49
  ///
50
  /// In general, %NetworkSimplex is the fastest implementation available
51
  /// in LEMON for this problem.
52
  /// Moreover, it supports both directions of the supply/demand inequality
53
  /// constraints. For more information, see \ref SupplyType.
50
  /// In general, \ref NetworkSimplex and \ref CostScaling are the fastest
51
  /// implementations available in LEMON for this problem.
52
  /// Furthermore, this class supports both directions of the supply/demand
53
  /// inequality constraints. For more information, see \ref SupplyType.
54 54
  ///
55 55
  /// Most of the parameters of the problem (except for the digraph)
56 56
  /// can be given using separate functions, and the algorithm can be
57 57
  /// executed using the \ref run() function. If some parameters are not
... ...
@@ -124,9 +124,9 @@
124 124
    /// \ref NetworkSimplex provides five different pivot rule
125 125
    /// implementations that significantly affect the running time
126 126
    /// of the algorithm.
127 127
    /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
128
    /// proved to be the most efficient and the most robust on various
128
    /// turend out to be the most efficient and the most robust on various
129 129
    /// test inputs.
130 130
    /// However, another pivot rule can be selected using the \ref run()
131 131
    /// function with the proper parameter.
132 132
    enum PivotRule {
... ...
@@ -166,9 +166,9 @@
166 166
    typedef std::vector<int> IntVector;
167 167
    typedef std::vector<Value> ValueVector;
168 168
    typedef std::vector<Cost> CostVector;
169 169
    typedef std::vector<signed char> CharVector;
170
    // Note: vector<signed char> is used instead of vector<ArcState> and 
170
    // Note: vector<signed char> is used instead of vector<ArcState> and
171 171
    // vector<ArcDirection> for efficiency reasons
172 172

	
173 173
    // State constants for arcs
174 174
    enum ArcState {
... ...
@@ -733,8 +733,10 @@
733 733
    /// Its \c Value type must be convertible to the \c Value type
734 734
    /// of the algorithm.
735 735
    ///
736 736
    /// \return <tt>(*this)</tt>
737
    ///
738
    /// \sa supplyType()
737 739
    template<typename SupplyMap>
738 740
    NetworkSimplex& supplyMap(const SupplyMap& map) {
739 741
      for (NodeIt n(_graph); n != INVALID; ++n) {
740 742
        _supply[_node_id[n]] = map[n];
... ...
@@ -749,9 +751,9 @@
749 751
    /// If neither this function nor \ref supplyMap() is used before
750 752
    /// calling \ref run(), the supply of each node will be set to zero.
751 753
    ///
752 754
    /// Using this function has the same effect as using \ref supplyMap()
753
    /// with such a map in which \c k is assigned to \c s, \c -k is
755
    /// with a map in which \c k is assigned to \c s, \c -k is
754 756
    /// assigned to \c t and all other nodes have zero supply value.
755 757
    ///
756 758
    /// \param s The source node.
757 759
    /// \param t The target node.
0 comments (0 inline)