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
Show white space 6 line context
... ... 
@@ -37,5 +37,5 @@
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.
... ... 
@@ -77,8 +77,8 @@
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.
... ... 
@@ -124,3 +124,3 @@
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
... ... 
@@ -309,3 +309,3 @@
309 309 
    {
310 
      // Check the value types
310 
      // Check the number types
311 311 
      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
... ... 
@@ -413,3 +413,3 @@
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 
    ///
... ... 
@@ -516,3 +516,3 @@
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.
... ... 
@@ -529,3 +529,3 @@
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
lemon/cost_scaling.h
Ignore white space 6 line context
... ... 
@@ -42,5 +42,5 @@
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.
... ... 
@@ -103,8 +103,8 @@
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.
... ... 
@@ -159,3 +159,3 @@
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
... ... 
@@ -327,3 +327,3 @@
327 327 
    {
328 
      // Check the value types
328 
      // Check the number types
329 329 
      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
... ... 
@@ -435,3 +435,3 @@
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 
    ///
... ... 
@@ -551,3 +551,3 @@
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
... ... 
@@ -573,3 +573,3 @@
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.
lemon/network_simplex.h
Ignore white space 6 line context
... ... 
@@ -45,9 +45,9 @@
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.
... ... 
@@ -60,8 +60,8 @@
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.
... ... 
@@ -128,3 +128,3 @@
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()
... ... 
@@ -639,3 +639,3 @@
639 639 
    {
640 
      // Check the value types
640 
      // Check the number types
641 641 
      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
... ... 
@@ -731,3 +731,3 @@
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 
    ///
0 comments (0 inline)