Changeset - r812:4b1b378823dc
« 811:fe80a8
813:25804e »
gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Small doc improvements + unifications in MCF classes (#180)
0 3 0
default
3 files changed with 32 insertions and 32 deletions:
lemon/capacity_scaling.h
10
10
lemon/cost_scaling.h
10
10
lemon/network_simplex.h
12
12
↑ Collapse diff ↑
lemon/capacity_scaling.h
Ignore white space 4 line context
... ... 
@@ -36,7 +36,7 @@
36 36 
  /// Default traits class of CapacityScaling algorithm.
37 37 
  /// \tparam GR Digraph type.
38 
  /// \tparam V The value type used for flow amounts, capacity bounds
38 
  /// \tparam V The number type used for flow amounts, capacity bounds
39 39 
  /// and supply values. By default it is \c int.
40 
  /// \tparam C The value type used for costs and potentials.
40 
  /// \tparam C The number type used for costs and potentials.
41 41 
  /// By default it is the same as \c V.
42 42 
  template <typename GR, typename V = int, typename C = V>
... ... 
@@ -76,10 +76,10 @@
76 76 
  ///
77 77 
  /// \tparam GR The digraph type the algorithm runs on.
78 
  /// \tparam V The value type used for flow amounts, capacity bounds
78 
  /// \tparam V The number type used for flow amounts, capacity bounds
79 79 
  /// and supply values in the algorithm. By default it is \c int.
80 
  /// \tparam C The value type used for costs and potentials in the
80 
  /// \tparam C The number type used for costs and potentials in the
81 81 
  /// algorithm. By default it is the same as \c V.
82 82 
  ///
83 
  /// \warning Both value types must be signed and all input data must
83 
  /// \warning Both number types must be signed and all input data must
84 84 
  /// be integer.
85 85 
  /// \warning This algorithm does not support negative costs for such
... ... 
@@ -123,5 +123,5 @@
123 123 
      /// The digraph contains an arc of negative cost and infinite
124 124 
      /// upper bound. It means that the objective function is unbounded
125 
      /// on that arc, however note that it could actually be bounded
125 
      /// on that arc, however, note that it could actually be bounded
126 126 
      /// over the feasible flows, but this algroithm cannot handle
127 127 
      /// these cases.
... ... 
@@ -308,5 +308,5 @@
308 308 
          std::numeric_limits<Value>::max())
309 309 
    {
310 
      // Check the value types
310 
      // Check the number types
311 311 
      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
312 312 
        "The flow type of CapacityScaling must be signed");
... ... 
@@ -412,5 +412,5 @@
412 412 
    /// If it is not used before calling \ref run(), the upper bounds
413 413 
    /// will be set to \ref INF on all arcs (i.e. the flow value will be
414 
    /// unbounded from above on each arc).
414 
    /// unbounded from above).
415 415 
    ///
416 416 
    /// \param map An arc map storing the upper bounds.
... ... 
@@ -515,5 +515,5 @@
515 515 
    /// \ref reset() is called, thus only the modified parameters
516 516 
    /// have to be set again. See \ref reset() for examples.
517 
    /// However the underlying digraph must not be modified after this
517 
    /// However, the underlying digraph must not be modified after this
518 518 
    /// class have been constructed, since it copies and extends the graph.
519 519 
    ///
... ... 
@@ -528,5 +528,5 @@
528 528 
    /// \n \c UNBOUNDED if the digraph contains an arc of negative cost
529 529 
    /// and infinite upper bound. It means that the objective function
530 
    /// is unbounded on that arc, however note that it could actually be
530 
    /// is unbounded on that arc, however, note that it could actually be
531 531 
    /// bounded over the feasible flows, but this algroithm cannot handle
532 532 
    /// these cases.
lemon/cost_scaling.h
Ignore white space 4 line context
... ... 
@@ -41,7 +41,7 @@
41 41 
  /// Default traits class of CostScaling algorithm.
42 42 
  /// \tparam GR Digraph type.
43 
  /// \tparam V The value type used for flow amounts, capacity bounds
43 
  /// \tparam V The number type used for flow amounts, capacity bounds
44 44 
  /// and supply values. By default it is \c int.
45 
  /// \tparam C The value type used for costs and potentials.
45 
  /// \tparam C The number type used for costs and potentials.
46 46 
  /// By default it is the same as \c V.
47 47 
#ifdef DOXYGEN
... ... 
@@ -102,10 +102,10 @@
102 102 
  ///
103 103 
  /// \tparam GR The digraph type the algorithm runs on.
104 
  /// \tparam V The value type used for flow amounts, capacity bounds
104 
  /// \tparam V The number type used for flow amounts, capacity bounds
105 105 
  /// and supply values in the algorithm. By default it is \c int.
106 
  /// \tparam C The value type used for costs and potentials in the
106 
  /// \tparam C The number type used for costs and potentials in the
107 107 
  /// algorithm. By default it is the same as \c V.
108 108 
  ///
109 
  /// \warning Both value types must be signed and all input data must
109 
  /// \warning Both number types must be signed and all input data must
110 110 
  /// be integer.
111 111 
  /// \warning This algorithm does not support negative costs for such
... ... 
@@ -158,5 +158,5 @@
158 158 
      /// The digraph contains an arc of negative cost and infinite
159 159 
      /// upper bound. It means that the objective function is unbounded
160 
      /// on that arc, however note that it could actually be bounded
160 
      /// on that arc, however, note that it could actually be bounded
161 161 
      /// over the feasible flows, but this algroithm cannot handle
162 162 
      /// these cases.
... ... 
@@ -326,5 +326,5 @@
326 326 
          std::numeric_limits<Value>::max())
327 327 
    {
328 
      // Check the value types
328 
      // Check the number types
329 329 
      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
330 330 
        "The flow type of CostScaling must be signed");
... ... 
@@ -434,5 +434,5 @@
434 434 
    /// If it is not used before calling \ref run(), the upper bounds
435 435 
    /// will be set to \ref INF on all arcs (i.e. the flow value will be
436 
    /// unbounded from above on each arc).
436 
    /// unbounded from above).
437 437 
    ///
438 438 
    /// \param map An arc map storing the upper bounds.
... ... 
@@ -550,5 +550,5 @@
550 550 
    /// \n \c UNBOUNDED if the digraph contains an arc of negative cost
551 551 
    /// and infinite upper bound. It means that the objective function
552 
    /// is unbounded on that arc, however note that it could actually be
552 
    /// is unbounded on that arc, however, note that it could actually be
553 553 
    /// bounded over the feasible flows, but this algroithm cannot handle
554 554 
    /// these cases.
... ... 
@@ -572,5 +572,5 @@
572 572 
    /// used, all the parameters given before are kept for the next
573 573 
    /// \ref run() call.
574 
    /// However the underlying digraph must not be modified after this
574 
    /// However, the underlying digraph must not be modified after this
575 575 
    /// class have been constructed, since it copies and extends the graph.
576 576 
    ///
lemon/network_simplex.h
Ignore white space 4 line context
... ... 
@@ -44,11 +44,11 @@
44 44 
  /// \ref amo93networkflows, \ref dantzig63linearprog,
45 45 
  /// \ref kellyoneill91netsimplex.
46 
  /// This algorithm is a specialized version of the linear programming
47 
  /// simplex method directly for the minimum cost flow problem.
48 
  /// It is one of the most efficient solution methods.
46 
  /// This algorithm is a highly efficient specialized version of the
47 
  /// linear programming simplex method directly for the minimum cost
48 
  /// flow problem.
49 49 
  ///
50 
  /// In general this class is the fastest implementation available
51 
  /// in LEMON for the minimum cost flow problem.
52 
  /// Moreover it supports both directions of the supply/demand inequality
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 53 
  /// constraints. For more information, see \ref SupplyType.
54 54 
  ///
... ... 
@@ -59,10 +59,10 @@
59 59 
  ///
60 60 
  /// \tparam GR The digraph type the algorithm runs on.
61 
  /// \tparam V The value type used for flow amounts, capacity bounds
61 
  /// \tparam V The number type used for flow amounts, capacity bounds
62 62 
  /// and supply values in the algorithm. By default, it is \c int.
63 
  /// \tparam C The value type used for costs and potentials in the
63 
  /// \tparam C The number type used for costs and potentials in the
64 64 
  /// algorithm. By default, it is the same as \c V.
65 65 
  ///
66 
  /// \warning Both value types must be signed and all input data must
66 
  /// \warning Both number types must be signed and all input data must
67 67 
  /// be integer.
68 68 
  ///
... ... 
@@ -127,5 +127,5 @@
127 127 
    /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
128 128 
    /// proved to be the most efficient and the most robust on various
129 
    /// test inputs according to our benchmark tests.
129 
    /// test inputs.
130 130 
    /// However, another pivot rule can be selected using the \ref run()
131 131 
    /// function with the proper parameter.
... ... 
@@ -638,5 +638,5 @@
638 638 
          std::numeric_limits<Value>::infinity() : MAX)
639 639 
    {
640 
      // Check the value types
640 
      // Check the number types
641 641 
      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
642 642 
        "The flow type of NetworkSimplex must be signed");
... ... 
@@ -730,5 +730,5 @@
730 730 
    /// If it is not used before calling \ref run(), the upper bounds
731 731 
    /// will be set to \ref INF on all arcs (i.e. the flow value will be
732 
    /// unbounded from above on each arc).
732 
    /// unbounded from above).
733 733 
    ///
734 734 
    /// \param map An arc map storing the upper bounds.
0 comments (0 inline)