lemon: comparison lemon/hartmann_orlin

equal deleted inserted replaced

-:56f00b0ea52c
+:482d63db0004
 * express or implied, and with no claim as to its suitability for any
 * purpose.
 *
 */
-#ifndef LEMON_HARTMANN_ORLIN_H
+#ifndef LEMON_HARTMANN_ORLIN_MMC_H
-#define LEMON_HARTMANN_ORLIN_H
+#define LEMON_HARTMANN_ORLIN_MMC_H
 /// \ingroup min_mean_cycle
 ///
 /// \file
 /// \brief Hartmann-Orlin's algorithm for finding a minimum mean cycle.
 #include <lemon/tolerance.h>
 #include <lemon/connectivity.h>
 namespace lemon {
-/// \brief Default traits class of HartmannOrlin algorithm.
+/// \brief Default traits class of HartmannOrlinMmc class.
 ///
-/// Default traits class of HartmannOrlin algorithm.
+/// Default traits class of HartmannOrlinMmc class.
 /// \tparam GR The type of the digraph.
-/// \tparam LEN The type of the length map.
+/// \tparam CM The type of the cost map.
 /// It must conform to the \ref concepts::Rea_data "Rea_data" concept.
 #ifdef DOXYGEN
-template <typename GR, typename LEN>
+template <typename GR, typename CM>
 #else
-template <typename GR, typename LEN,
+template <typename GR, typename CM,
-bool integer = std::numeric_limits<typename LEN::Value>::is_integer>
+bool integer = std::numeric_limits<typename CM::Value>::is_integer>
 #endif
-struct HartmannOrlinDefaultTraits
+struct HartmannOrlinMmcDefaultTraits
 {
 /// The type of the digraph
 typedef GR Digraph;
-/// The type of the length map
+/// The type of the cost map
-typedef LEN LengthMap;
+typedef CM CostMap;
-/// The type of the arc lengths
+/// The type of the arc costs
-typedef typename LengthMap::Value Value;
+typedef typename CostMap::Value Cost;
-/// \brief The large value type used for internal computations
+/// \brief The large cost type used for internal computations
 ///
-/// The large value type used for internal computations.
+/// The large cost type used for internal computations.
-/// It is \c long \c long if the \c Value type is integer,
+/// It is \c long \c long if the \c Cost type is integer,
 /// otherwise it is \c double.
-/// \c Value must be convertible to \c LargeValue.
+/// \c Cost must be convertible to \c LargeCost.
-typedef double LargeValue;
+typedef double LargeCost;
 /// The tolerance type used for internal computations
-typedef lemon::Tolerance<LargeValue> Tolerance;
+typedef lemon::Tolerance<LargeCost> Tolerance;
 /// \brief The path type of the found cycles
 ///
 /// The path type of the found cycles.
 /// It must conform to the \ref lemon::concepts::Path "Path" concept
 /// and it must have an \c addFront() function.
 typedef lemon::Path<Digraph> Path;
 };
-// Default traits class for integer value types
+// Default traits class for integer cost types
-template <typename GR, typename LEN>
+template <typename GR, typename CM>
-struct HartmannOrlinDefaultTraits<GR, LEN, true>
+struct HartmannOrlinMmcDefaultTraits<GR, CM, true>
 {
 typedef GR Digraph;
-typedef LEN LengthMap;
+typedef CM CostMap;
-typedef typename LengthMap::Value Value;
+typedef typename CostMap::Value Cost;
 #ifdef LEMON_HAVE_LONG_LONG
-typedef long long LargeValue;
+typedef long long LargeCost;
 #else
-typedef long LargeValue;
+typedef long LargeCost;
 #endif
-typedef lemon::Tolerance<LargeValue> Tolerance;
+typedef lemon::Tolerance<LargeCost> Tolerance;
 typedef lemon::Path<Digraph> Path;
 };
 /// \addtogroup min_mean_cycle
 /// \brief Implementation of the Hartmann-Orlin algorithm for finding
 /// a minimum mean cycle.
 ///
 /// This class implements the Hartmann-Orlin algorithm for finding
-/// a directed cycle of minimum mean length (cost) in a digraph
+/// a directed cycle of minimum mean cost in a digraph
 /// \ref amo93networkflows, \ref dasdan98minmeancycle.
 /// It is an improved version of \ref Karp "Karp"'s original algorithm,
 /// it applies an efficient early termination scheme.
 /// It runs in time O(ne) and uses space O(n<sup>2</sup>+e).
 ///
 /// \tparam GR The type of the digraph the algorithm runs on.
-/// \tparam LEN The type of the length map. The default
+/// \tparam CM The type of the cost map. The default
 /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
 /// \tparam TR The traits class that defines various types used by the
-/// algorithm. By default, it is \ref HartmannOrlinDefaultTraits
+/// algorithm. By default, it is \ref HartmannOrlinMmcDefaultTraits
-/// "HartmannOrlinDefaultTraits<GR, LEN>".
+/// "HartmannOrlinMmcDefaultTraits<GR, CM>".
 /// In most cases, this parameter should not be set directly,
 /// consider to use the named template parameters instead.
 #ifdef DOXYGEN
-template <typename GR, typename LEN, typename TR>
+template <typename GR, typename CM, typename TR>
 #else
 template < typename GR,
-typename LEN = typename GR::template ArcMap<int>,
+typename CM = typename GR::template ArcMap<int>,
-typename TR = HartmannOrlinDefaultTraits<GR, LEN> >
+typename TR = HartmannOrlinMmcDefaultTraits<GR, CM> >
 #endif
-class HartmannOrlin
+class HartmannOrlinMmc
 {
 public:
 /// The type of the digraph
 typedef typename TR::Digraph Digraph;
-/// The type of the length map
+/// The type of the cost map
-typedef typename TR::LengthMap LengthMap;
+typedef typename TR::CostMap CostMap;
-/// The type of the arc lengths
+/// The type of the arc costs
-typedef typename TR::Value Value;
+typedef typename TR::Cost Cost;
-/// \brief The large value type
+/// \brief The large cost type
 ///
-/// The large value type used for internal computations.
+/// The large cost type used for internal computations.
-/// By default, it is \c long \c long if the \c Value type is integer,
+/// By default, it is \c long \c long if the \c Cost type is integer,
 /// otherwise it is \c double.
-typedef typename TR::LargeValue LargeValue;
+typedef typename TR::LargeCost LargeCost;
 /// The tolerance type
 typedef typename TR::Tolerance Tolerance;
 /// \brief The path type of the found cycles
 ///
 /// The path type of the found cycles.
-/// Using the \ref HartmannOrlinDefaultTraits "default traits class",
+/// Using the \ref HartmannOrlinMmcDefaultTraits "default traits class",
 /// it is \ref lemon::Path "Path<Digraph>".
 typedef typename TR::Path Path;
-/// The \ref HartmannOrlinDefaultTraits "traits class" of the algorithm
+/// The \ref HartmannOrlinMmcDefaultTraits "traits class" of the algorithm
 typedef TR Traits;
 private:
 TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
 // Data sturcture for path data
 struct PathData
 {
-LargeValue dist;
+LargeCost dist;
 Arc pred;
-PathData(LargeValue d, Arc p = INVALID) :
+PathData(LargeCost d, Arc p = INVALID) :
 dist(d), pred(p) {}
 };
 typedef typename Digraph::template NodeMap<std::vector<PathData> >
 PathDataNodeMap;
 private:
 // The digraph the algorithm runs on
 const Digraph &_gr;
-// The length of the arcs
+// The cost of the arcs
-const LengthMap &_length;
+const CostMap &_cost;
 // Data for storing the strongly connected components
 int _comp_num;
 typename Digraph::template NodeMap<int> _comp;
 std::vector<std::vector<Node> > _comp_nodes;
 std::vector<Node>* _nodes;
 typename Digraph::template NodeMap<std::vector<Arc> > _out_arcs;
 // Data for the found cycles
 bool _curr_found, _best_found;
-LargeValue _curr_length, _best_length;
+LargeCost _curr_cost, _best_cost;
 int _curr_size, _best_size;
 Node _curr_node, _best_node;
 int _curr_level, _best_level;
 Path *_cycle_path;
 std::vector<Node> _process;
 Tolerance _tolerance;
 // Infinite constant
-const LargeValue INF;
+const LargeCost INF;
 public:
 /// \name Named Template Parameters
 /// @{
 template <typename T>
-struct SetLargeValueTraits : public Traits {
+struct SetLargeCostTraits : public Traits {
-typedef T LargeValue;
+typedef T LargeCost;
 typedef lemon::Tolerance<T> Tolerance;
 };
 /// \brief \ref named-templ-param "Named parameter" for setting
-/// \c LargeValue type.
+/// \c LargeCost type.
 ///
-/// \ref named-templ-param "Named parameter" for setting \c LargeValue
+/// \ref named-templ-param "Named parameter" for setting \c LargeCost
 /// type. It is used for internal computations in the algorithm.
 template <typename T>
-struct SetLargeValue
+struct SetLargeCost
-: public HartmannOrlin<GR, LEN, SetLargeValueTraits<T> > {
+: public HartmannOrlinMmc<GR, CM, SetLargeCostTraits<T> > {
-typedef HartmannOrlin<GR, LEN, SetLargeValueTraits<T> > Create;
+typedef HartmannOrlinMmc<GR, CM, SetLargeCostTraits<T> > Create;
 };
 template <typename T>
 struct SetPathTraits : public Traits {
 typedef T Path;
 /// type of the found cycles.
 /// It must conform to the \ref lemon::concepts::Path "Path" concept
 /// and it must have an \c addFront() function.
 template <typename T>
 struct SetPath
-: public HartmannOrlin<GR, LEN, SetPathTraits<T> > {
+: public HartmannOrlinMmc<GR, CM, SetPathTraits<T> > {
-typedef HartmannOrlin<GR, LEN, SetPathTraits<T> > Create;
+typedef HartmannOrlinMmc<GR, CM, SetPathTraits<T> > Create;
 };
 /// @}
 protected:
-HartmannOrlin() {}
+HartmannOrlinMmc() {}
 public:
 /// \brief Constructor.
 ///
 /// The constructor of the class.
 ///
 /// \param digraph The digraph the algorithm runs on.
-/// \param length The lengths (costs) of the arcs.
+/// \param cost The costs of the arcs.
-HartmannOrlin( const Digraph &digraph,
+HartmannOrlinMmc( const Digraph &digraph,
-const LengthMap &length ) :
+const CostMap &cost ) :
-_gr(digraph), _length(length), _comp(digraph), _out_arcs(digraph),
+_gr(digraph), _cost(cost), _comp(digraph), _out_arcs(digraph),
-_best_found(false), _best_length(0), _best_size(1),
+_best_found(false), _best_cost(0), _best_size(1),
 _cycle_path(NULL), _local_path(false), _data(digraph),
-INF(std::numeric_limits<LargeValue>::has_infinity ?
+INF(std::numeric_limits<LargeCost>::has_infinity ?
-std::numeric_limits<LargeValue>::infinity() :
+std::numeric_limits<LargeCost>::infinity() :
-std::numeric_limits<LargeValue>::max())
+std::numeric_limits<LargeCost>::max())
 {}
 /// Destructor.
-~HartmannOrlin() {
+~HartmannOrlinMmc() {
 if (_local_path) delete _cycle_path;
 }
 /// \brief Set the path structure for storing the found cycle.
 ///
 /// This function sets an external path structure for storing the
 /// found cycle.
 ///
 /// If you don't call this function before calling \ref run() or
-/// \ref findMinMean(), it will allocate a local \ref Path "path"
+/// \ref findCycleMean(), it will allocate a local \ref Path "path"
 /// structure. The destuctor deallocates this automatically
 /// allocated object, of course.
 ///
 /// \note The algorithm calls only the \ref lemon::Path::addFront()
 /// "addFront()" function of the given path structure.
 ///
 /// \return <tt>(*this)</tt>
-HartmannOrlin& cycle(Path &path) {
+HartmannOrlinMmc& cycle(Path &path) {
 if (_local_path) {
 delete _cycle_path;
 _local_path = false;
 }
 _cycle_path = &path;
 /// \brief Set the tolerance used by the algorithm.
 ///
 /// This function sets the tolerance object used by the algorithm.
 ///
 /// \return <tt>(*this)</tt>
-HartmannOrlin& tolerance(const Tolerance& tolerance) {
+HartmannOrlinMmc& tolerance(const Tolerance& tolerance) {
 _tolerance = tolerance;
 return *this;
 }
 /// \brief Return a const reference to the tolerance.
 }
 /// \name Execution control
 /// The simplest way to execute the algorithm is to call the \ref run()
 /// function.\n
-/// If you only need the minimum mean length, you may call
+/// If you only need the minimum mean cost, you may call
-/// \ref findMinMean().
+/// \ref findCycleMean().
 /// @{
 /// \brief Run the algorithm.
 ///
 /// This function runs the algorithm.
 /// It can be called more than once (e.g. if the underlying digraph
-/// and/or the arc lengths have been modified).
+/// and/or the arc costs have been modified).
 ///
 /// \return \c true if a directed cycle exists in the digraph.
 ///
 /// \note <tt>mmc.run()</tt> is just a shortcut of the following code.
 /// \code
-///   return mmc.findMinMean() && mmc.findCycle();
+///   return mmc.findCycleMean() && mmc.findCycle();
 /// \endcode
 bool run() {
-return findMinMean() && findCycle();
+return findCycleMean() && findCycle();
 }
 /// \brief Find the minimum cycle mean.
 ///
-/// This function finds the minimum mean length of the directed
+/// This function finds the minimum mean cost of the directed
 /// cycles in the digraph.
 ///
 /// \return \c true if a directed cycle exists in the digraph.
-bool findMinMean() {
+bool findCycleMean() {
 // Initialization and find strongly connected components
 init();
 findComponents();
 // Find the minimum cycle mean in the components
 if (!initComponent(comp)) continue;
 processRounds();
 // Update the best cycle (global minimum mean cycle)
 if ( _curr_found && (!_best_found ||
-_curr_length * _best_size < _best_length * _curr_size) ) {
+_curr_cost * _best_size < _best_cost * _curr_size) ) {
 _best_found = true;
-_best_length = _curr_length;
+_best_cost = _curr_cost;
 _best_size = _curr_size;
 _best_node = _curr_node;
 _best_level = _curr_level;
 }
 }
 return _best_found;
 }
 /// \brief Find a minimum mean directed cycle.
 ///
-/// This function finds a directed cycle of minimum mean length
+/// This function finds a directed cycle of minimum mean cost
-/// in the digraph using the data computed by findMinMean().
+/// in the digraph using the data computed by findCycleMean().
 ///
 /// \return \c true if a directed cycle exists in the digraph.
 ///
-/// \pre \ref findMinMean() must be called before using this function.
+/// \pre \ref findCycleMean() must be called before using this function.
 bool findCycle() {
 if (!_best_found) return false;
 IntNodeMap reached(_gr, -1);
 int r = _best_level + 1;
 Node u = _best_node;
 u = _gr.source(_data[u][r].pred);
 }
 r = reached[u];
 Arc e = _data[u][r].pred;
 _cycle_path->addFront(e);
-_best_length = _length[e];
+_best_cost = _cost[e];
 _best_size = 1;
 Node v;
 while ((v = _gr.source(e)) != u) {
 e = _data[v][--r].pred;
 _cycle_path->addFront(e);
-_best_length += _length[e];
+_best_cost += _cost[e];
 ++_best_size;
 }
 return true;
 }
 /// functions.\n
 /// The algorithm should be executed before using them.
 /// @{
-/// \brief Return the total length of the found cycle.
+/// \brief Return the total cost of the found cycle.
 ///
-/// This function returns the total length of the found cycle.
+/// This function returns the total cost of the found cycle.
 ///
-/// \pre \ref run() or \ref findMinMean() must be called before
+/// \pre \ref run() or \ref findCycleMean() must be called before
 /// using this function.
-Value cycleLength() const {
+Cost cycleCost() const {
-return static_cast<Value>(_best_length);
+return static_cast<Cost>(_best_cost);
 }
 /// \brief Return the number of arcs on the found cycle.
 ///
 /// This function returns the number of arcs on the found cycle.
 ///
-/// \pre \ref run() or \ref findMinMean() must be called before
+/// \pre \ref run() or \ref findCycleMean() must be called before
 /// using this function.
-int cycleArcNum() const {
+int cycleSize() const {
 return _best_size;
 }
-/// \brief Return the mean length of the found cycle.
+/// \brief Return the mean cost of the found cycle.
 ///
-/// This function returns the mean length of the found cycle.
+/// This function returns the mean cost of the found cycle.
 ///
 /// \note <tt>alg.cycleMean()</tt> is just a shortcut of the
 /// following code.
 /// \code
-///   return static_cast<double>(alg.cycleLength()) / alg.cycleArcNum();
+///   return static_cast<double>(alg.cycleCost()) / alg.cycleSize();
 /// \endcode
 ///
-/// \pre \ref run() or \ref findMinMean() must be called before
+/// \pre \ref run() or \ref findCycleMean() must be called before
 /// using this function.
 double cycleMean() const {
-return static_cast<double>(_best_length) / _best_size;
+return static_cast<double>(_best_cost) / _best_size;
 }
 /// \brief Return the found cycle.
 ///
 /// This function returns a const reference to the path structure
 _local_path = true;
 _cycle_path = new Path;
 }
 _cycle_path->clear();
 _best_found = false;
-_best_length = 0;
+_best_cost = 0;
 _best_size = 1;
 _cycle_path->clear();
 for (NodeIt u(_gr); u != INVALID; ++u)
 _data[u].clear();
 }
 }
 return true;
 }
 // Process all rounds of computing path data for the current component.
-// _data[v][k] is the length of a shortest directed walk from the root
+// _data[v][k] is the cost of a shortest directed walk from the root
 // node to node v containing exactly k arcs.
 void processRounds() {
 Node start = (*_nodes)[0];
 _data[start][0] = PathData(0);
 _process.clear();
 // Process one round and rebuild _process
 void processNextBuildRound(int k) {
 std::vector<Node> next;
 Node u, v;
 Arc e;
-LargeValue d;
+LargeCost d;
 for (int i = 0; i < int(_process.size()); ++i) {
 u = _process[i];
 for (int j = 0; j < int(_out_arcs[u].size()); ++j) {
 e = _out_arcs[u][j];
 v = _gr.target(e);
-d = _data[u][k-1].dist + _length[e];
+d = _data[u][k-1].dist + _cost[e];
 if (_tolerance.less(d, _data[v][k].dist)) {
 if (_data[v][k].dist == INF) next.push_back(v);
 _data[v][k] = PathData(d, e);
 }
 }
 // Process one round using _nodes instead of _process
 void processNextFullRound(int k) {
 Node u, v;
 Arc e;
-LargeValue d;
+LargeCost d;
 for (int i = 0; i < int(_nodes->size()); ++i) {
 u = (*_nodes)[i];
 for (int j = 0; j < int(_out_arcs[u].size()); ++j) {
 e = _out_arcs[u][j];
 v = _gr.target(e);
-d = _data[u][k-1].dist + _length[e];
+d = _data[u][k-1].dist + _cost[e];
 if (_tolerance.less(d, _data[v][k].dist)) {
 _data[v][k] = PathData(d, e);
 }
 }
 }
 // Check early termination
 bool checkTermination(int k) {
 typedef std::pair<int, int> Pair;
 typename GR::template NodeMap<Pair> level(_gr, Pair(-1, 0));
-typename GR::template NodeMap<LargeValue> pi(_gr);
+typename GR::template NodeMap<LargeCost> pi(_gr);
 int n = _nodes->size();
-LargeValue length;
+LargeCost cost;
 int size;
 Node u;
 // Search for cycles that are already found
 _curr_found = false;
 u = (*_nodes)[i];
 if (_data[u][k].dist == INF) continue;
 for (int j = k; j >= 0; --j) {
 if (level[u].first == i && level[u].second > 0) {
 // A cycle is found
-length = _data[u][level[u].second].dist - _data[u][j].dist;
+cost = _data[u][level[u].second].dist - _data[u][j].dist;
 size = level[u].second - j;
-if (!_curr_found || length * _curr_size < _curr_length * size) {
+if (!_curr_found || cost * _curr_size < _curr_cost * size) {
-_curr_length = length;
+_curr_cost = cost;
 _curr_size = size;
 _curr_node = u;
 _curr_level = level[u].second;
 _curr_found = true;
 }
 	  }
 }
 }
 // If at least one cycle is found, check the optimality condition
-LargeValue d;
+LargeCost d;
 if (_curr_found && k < n) {
 // Find node potentials
 for (int i = 0; i < n; ++i) {
 u = (*_nodes)[i];
 pi[u] = INF;
 for (int j = 0; j <= k; ++j) {
 if (_data[u][j].dist < INF) {
-d = _data[u][j].dist * _curr_size - j * _curr_length;
+d = _data[u][j].dist * _curr_size - j * _curr_cost;
 if (_tolerance.less(d, pi[u])) pi[u] = d;
 }
 }
 }
 // Check the optimality condition for all arcs
 bool done = true;
 for (ArcIt a(_gr); a != INVALID; ++a) {
-if (_tolerance.less(_length[a] * _curr_size - _curr_length,
+if (_tolerance.less(_cost[a] * _curr_size - _curr_cost,
 pi[_gr.target(a)] - pi[_gr.source(a)]) ) {
 done = false;
 break;
 }
 }
 return done;
 }
 return (k == n);
 }
-}; //class HartmannOrlin
+}; //class HartmannOrlinMmc
 ///@}
 } //namespace lemon
-#endif //LEMON_HARTMANN_ORLIN_H
+#endif //LEMON_HARTMANN_ORLIN_MMC_H

changeset 942	d3ea191c3412
parent 941	a93f1a27d831
child 956	141f9c0db4a3