lemon/cost_scaling.h
changeset 844 a6eb9698c321
parent 830 75c97c3786d6
parent 825 75e6020b19b1
child 840 2914b6f0fde0
equal deleted inserted replaced
8:5effc608f19e 9:9fdcd1925b95
   102   /// executed using the \ref run() function. If some parameters are not
   102   /// executed using the \ref run() function. If some parameters are not
   103   /// specified, then default values will be used.
   103   /// specified, then default values will be used.
   104   ///
   104   ///
   105   /// \tparam GR The digraph type the algorithm runs on.
   105   /// \tparam GR The digraph type the algorithm runs on.
   106   /// \tparam V The number type used for flow amounts, capacity bounds
   106   /// \tparam V The number type used for flow amounts, capacity bounds
   107   /// and supply values in the algorithm. By default it is \c int.
   107   /// and supply values in the algorithm. By default, it is \c int.
   108   /// \tparam C The number type used for costs and potentials in the
   108   /// \tparam C The number type used for costs and potentials in the
   109   /// algorithm. By default it is the same as \c V.
   109   /// algorithm. By default, it is the same as \c V.
       
   110   /// \tparam TR The traits class that defines various types used by the
       
   111   /// algorithm. By default, it is \ref CostScalingDefaultTraits
       
   112   /// "CostScalingDefaultTraits<GR, V, C>".
       
   113   /// In most cases, this parameter should not be set directly,
       
   114   /// consider to use the named template parameters instead.
   110   ///
   115   ///
   111   /// \warning Both number types must be signed and all input data must
   116   /// \warning Both number types must be signed and all input data must
   112   /// be integer.
   117   /// be integer.
   113   /// \warning This algorithm does not support negative costs for such
   118   /// \warning This algorithm does not support negative costs for such
   114   /// arcs that have infinite upper bound.
   119   /// arcs that have infinite upper bound.
   134     typedef typename TR::Cost Cost;
   139     typedef typename TR::Cost Cost;
   135 
   140 
   136     /// \brief The large cost type
   141     /// \brief The large cost type
   137     ///
   142     ///
   138     /// The large cost type used for internal computations.
   143     /// The large cost type used for internal computations.
   139     /// Using the \ref CostScalingDefaultTraits "default traits class",
   144     /// By default, it is \c long \c long if the \c Cost type is integer,
   140     /// it is \c long \c long if the \c Cost type is integer,
       
   141     /// otherwise it is \c double.
   145     /// otherwise it is \c double.
   142     typedef typename TR::LargeCost LargeCost;
   146     typedef typename TR::LargeCost LargeCost;
   143 
   147 
   144     /// The \ref CostScalingDefaultTraits "traits class" of the algorithm
   148     /// The \ref CostScalingDefaultTraits "traits class" of the algorithm
   145     typedef TR Traits;
   149     typedef TR Traits;