gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Fix the doc in CapacityScaling: cost can be real numbers (#261)
0 1 0
default
1 file changed with 2 insertions and 2 deletions:
↑ Collapse diff ↑
Show white space 32 line context
... ...
@@ -74,34 +74,34 @@
74 74
  /// can be given using separate functions, and the algorithm can be
75 75
  /// executed using the \ref run() function. If some parameters are not
76 76
  /// specified, then default values will be used.
77 77
  ///
78 78
  /// \tparam GR The digraph type the algorithm runs on.
79 79
  /// \tparam V The number type used for flow amounts, capacity bounds
80 80
  /// and supply values in the algorithm. By default, it is \c int.
81 81
  /// \tparam C The number type used for costs and potentials in the
82 82
  /// algorithm. By default, it is the same as \c V.
83 83
  /// \tparam TR The traits class that defines various types used by the
84 84
  /// algorithm. By default, it is \ref CapacityScalingDefaultTraits
85 85
  /// "CapacityScalingDefaultTraits<GR, V, C>".
86 86
  /// In most cases, this parameter should not be set directly,
87 87
  /// consider to use the named template parameters instead.
88 88
  ///
89 89
  /// \warning Both \c V and \c C must be signed number types.
90
  /// \warning All input data (capacities, supply values, and costs) must
91
  /// be integer.
90
  /// \warning Capacity bounds and supply values must be integer, but
91
  /// arc costs can be arbitrary real numbers.
92 92
  /// \warning This algorithm does not support negative costs for
93 93
  /// arcs having infinite upper bound.
94 94
#ifdef DOXYGEN
95 95
  template <typename GR, typename V, typename C, typename TR>
96 96
#else
97 97
  template < typename GR, typename V = int, typename C = V,
98 98
             typename TR = CapacityScalingDefaultTraits<GR, V, C> >
99 99
#endif
100 100
  class CapacityScaling
101 101
  {
102 102
  public:
103 103

	
104 104
    /// The type of the digraph
105 105
    typedef typename TR::Digraph Digraph;
106 106
    /// The type of the flow amounts, capacity bounds and supply values
107 107
    typedef typename TR::Value Value;
0 comments (0 inline)