/* -*- C++ -*-

  * lemon/johnson.h - Part of LEMON, a generic C++ optimization library

  *

  * Copyright (C) 2006 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

  * (Egervary Research Group on Combinatorial Optimization, EGRES).

  *

  * Permission to use, modify and distribute this software is granted

  * provided that this copyright notice appears in all copies. For

  * precise terms see the accompanying LICENSE file.

  *

  * This software is provided "AS IS" with no warranty of any kind,

  * express or implied, and with no claim as to its suitability for any

  * purpose.

  *

  */

 #ifndef LEMON_JOHNSON_H

 #define LEMON_JOHNSON_H

 ///\ingroup flowalgs

 /// \file

 /// \brief Johnson algorithm.

 ///

 #include <lemon/list_graph.h>

 #include <lemon/graph_utils.h>

 #include <lemon/dijkstra.h>

 #include <lemon/bellman_ford.h>

 #include <lemon/invalid.h>

 #include <lemon/error.h>

 #include <lemon/maps.h>

 #include <lemon/matrix_maps.h>

 #include <limits>

 namespace lemon {

   /// \brief Default OperationTraits for the Johnson algorithm class.

   ///  

   /// It defines all computational operations and constants which are

   /// used in the Floyd-Warshall algorithm. The default implementation

   /// is based on the numeric_limits class. If the numeric type does not

   /// have infinity value then the maximum value is used as extremal

   /// infinity value.

   template <

     typename Value, 

     bool has_infinity = std::numeric_limits<Value>::has_infinity>

   struct JohnsonDefaultOperationTraits {

     /// \brief Gives back the zero value of the type.

     static Value zero() {

       return static_cast<Value>(0);

     }

     /// \brief Gives back the positive infinity value of the type.

     static Value infinity() {

       return std::numeric_limits<Value>::infinity();

     }

     /// \brief Gives back the sum of the given two elements.

     static Value plus(const Value& left, const Value& right) {

       return left + right;

     }

     /// \brief Gives back true only if the first value less than the second.

     static bool less(const Value& left, const Value& right) {

       return left < right;

     }

   };

   template <typename Value>

   struct JohnsonDefaultOperationTraits<Value, false> {

     static Value zero() {

       return static_cast<Value>(0);

     }

     static Value infinity() {

       return std::numeric_limits<Value>::max();

     }

     static Value plus(const Value& left, const Value& right) {

       if (left == infinity() || right == infinity()) return infinity();

       return left + right;

     }

     static bool less(const Value& left, const Value& right) {

       return left < right;

     }

   };

   /// \brief Default traits class of Johnson class.

   ///

   /// Default traits class of Johnson class.

   /// \param _Graph Graph type.

   /// \param _LegthMap Type of length map.

   template<class _Graph, class _LengthMap>

   struct JohnsonDefaultTraits {

     /// The graph type the algorithm runs on. 

     typedef _Graph Graph;

     /// \brief The type of the map that stores the edge lengths.

     ///

     /// The type of the map that stores the edge lengths.

     /// It must meet the \ref concept::ReadMap "ReadMap" concept.

     typedef _LengthMap LengthMap;

     // The type of the length of the edges.

     typedef typename _LengthMap::Value Value;

     /// \brief Operation traits for bellman-ford algorithm.

     ///

     /// It defines the infinity type on the given Value type

     /// and the used operation.

     /// \see JohnsonDefaultOperationTraits

     typedef JohnsonDefaultOperationTraits<Value> OperationTraits;

     /// The cross reference type used by heap.

     /// The cross reference type used by heap.

     /// Usually it is \c Graph::NodeMap<int>.

     typedef typename Graph::template NodeMap<int> HeapCrossRef;

     ///Instantiates a HeapCrossRef.

     ///This function instantiates a \ref HeapCrossRef. 

     /// \param graph is the graph, to which we would like to define the 

     /// HeapCrossRef.

     static HeapCrossRef *createHeapCrossRef(const Graph& graph) {

       return new HeapCrossRef(graph);

     }

     ///The heap type used by Dijkstra algorithm.

     ///The heap type used by Dijkstra algorithm.

     ///

     ///\sa BinHeap

     ///\sa Dijkstra

     typedef BinHeap<typename Graph::Node, typename LengthMap::Value,

 		    HeapCrossRef, std::less<Value> > Heap;

     ///Instantiates a Heap.

     ///This function instantiates a \ref Heap. 

     /// \param crossRef The cross reference for the heap.

     static Heap *createHeap(HeapCrossRef& crossRef) {

       return new Heap(crossRef);

     }

     /// \brief The type of the matrix map that stores the last edges of the 

     /// shortest paths.

     /// 

     /// The type of the map that stores the last edges of the shortest paths.

     /// It must be a matrix map with \c Graph::Edge value type.

     ///

     typedef DynamicMatrixMap<Graph, typename Graph::Node, 

 			     typename Graph::Edge> PredMap;

     /// \brief Instantiates a PredMap.

     /// 

     /// This function instantiates a \ref PredMap. 

     /// \param G is the graph, to which we would like to define the PredMap.

     /// \todo The graph alone may be insufficient for the initialization

     static PredMap *createPredMap(const Graph& graph) {

       return new PredMap(graph);

     }

     /// \brief The type of the matrix map that stores the dists of the nodes.

     ///

     /// The type of the matrix map that stores the dists of the nodes.

     /// It must meet the \ref concept::WriteMatrixMap "WriteMatrixMap" concept.

     ///

     typedef DynamicMatrixMap<Graph, typename Graph::Node, Value> DistMap;

     /// \brief Instantiates a DistMap.

     ///

     /// This function instantiates a \ref DistMap. 

     /// \param G is the graph, to which we would like to define the 

     /// \ref DistMap

     static DistMap *createDistMap(const _Graph& graph) {

       return new DistMap(graph);

     }

   };

   /// \brief %Johnson algorithm class.

   ///

   /// \ingroup flowalgs

   /// This class provides an efficient implementation of \c %Johnson 

   /// algorithm. The edge lengths are passed to the algorithm using a

   /// \ref concept::ReadMap "ReadMap", so it is easy to change it to any 

   /// kind of length.

   ///

   /// The algorithm solves the shortest path problem for each pair

   /// of node when the edges can have negative length but the graph should

   /// not contain cycles with negative sum of length. If we can assume

   /// that all edge is non-negative in the graph then the dijkstra algorithm

   /// should be used from each node.

   ///

   /// The complexity of this algorithm is $O(n^2 * log(n) + n * log(n) * e)$ or

   /// with fibonacci heap O(n^2 * log(n) + n * e). Usually the fibonacci heap

   /// implementation is slower than either binary heap implementation or the 

   /// Floyd-Warshall algorithm. 

   ///

   /// The type of the length is determined by the

   /// \ref concept::ReadMap::Value "Value" of the length map.

   ///

   /// \param _Graph The graph type the algorithm runs on. The default value

   /// is \ref ListGraph. The value of _Graph is not used directly by

   /// Johnson, it is only passed to \ref JohnsonDefaultTraits.

   /// \param _LengthMap This read-only EdgeMap determines the lengths of the

   /// edges. It is read once for each edge, so the map may involve in

   /// relatively time consuming process to compute the edge length if

   /// it is necessary. The default map type is \ref

   /// concept::StaticGraph::EdgeMap "Graph::EdgeMap<int>".  The value

   /// of _LengthMap is not used directly by Johnson, it is only passed 

   /// to \ref JohnsonDefaultTraits.  \param _Traits Traits class to set

   /// various data types used by the algorithm.  The default traits

   /// class is \ref JohnsonDefaultTraits

   /// "JohnsonDefaultTraits<_Graph,_LengthMap>".  See \ref

   /// JohnsonDefaultTraits for the documentation of a Johnson traits

   /// class.

   ///

   /// \author Balazs Dezso

 #ifdef DOXYGEN

   template <typename _Graph, typename _LengthMap, typename _Traits>

 #else

   template <typename _Graph=ListGraph,

 	    typename _LengthMap=typename _Graph::template EdgeMap<int>,

 	    typename _Traits=JohnsonDefaultTraits<_Graph,_LengthMap> >

 #endif

   class Johnson {

   public:

     /// \brief \ref Exception for uninitialized parameters.

     ///

     /// This error represents problems in the initialization

     /// of the parameters of the algorithms.

     class UninitializedParameter : public lemon::UninitializedParameter {

     public:

       virtual const char* exceptionName() const {

 	return "lemon::Johnson::UninitializedParameter";

       }

     };

     typedef _Traits Traits;

     ///The type of the underlying graph.

     typedef typename _Traits::Graph Graph;

     typedef typename Graph::Node Node;

     typedef typename Graph::NodeIt NodeIt;

     typedef typename Graph::Edge Edge;

     typedef typename Graph::EdgeIt EdgeIt;

     /// \brief The type of the length of the edges.

     typedef typename _Traits::LengthMap::Value Value;

     /// \brief The type of the map that stores the edge lengths.

     typedef typename _Traits::LengthMap LengthMap;

     /// \brief The type of the map that stores the last

     /// edges of the shortest paths. The type of the PredMap

     /// is a matrix map for Edges

     typedef typename _Traits::PredMap PredMap;

     /// \brief The type of the map that stores the dists of the nodes.

     /// The type of the DistMap is a matrix map for Values

     typedef typename _Traits::DistMap DistMap;

     /// \brief The operation traits.

     typedef typename _Traits::OperationTraits OperationTraits;

     ///The cross reference type used for the current heap.

     typedef typename _Traits::HeapCrossRef HeapCrossRef;

     ///The heap type used by the dijkstra algorithm.

     typedef typename _Traits::Heap Heap;

   private:

     /// Pointer to the underlying graph.

     const Graph *graph;

     /// Pointer to the length map

     const LengthMap *length;

     ///Pointer to the map of predecessors edges.

     PredMap *_pred;

     ///Indicates if \ref _pred is locally allocated (\c true) or not.

     bool local_pred;

     ///Pointer to the map of distances.

     DistMap *_dist;

     ///Indicates if \ref _dist is locally allocated (\c true) or not.

     bool local_dist;

     ///Pointer to the heap cross references.

     HeapCrossRef *_heap_cross_ref;

     ///Indicates if \ref _heap_cross_ref is locally allocated (\c true) or not.

     bool local_heap_cross_ref;

     ///Pointer to the heap.

     Heap *_heap;

     ///Indicates if \ref _heap is locally allocated (\c true) or not.

     bool local_heap;

     /// Creates the maps if necessary.

     void create_maps() {

       if(!_pred) {

 	local_pred = true;

 	_pred = Traits::createPredMap(*graph);

       }

       if(!_dist) {

 	local_dist = true;

 	_dist = Traits::createDistMap(*graph);

       }

       if (!_heap_cross_ref) {

 	local_heap_cross_ref = true;

 	_heap_cross_ref = Traits::createHeapCrossRef(*graph);

       }

       if (!_heap) {

 	local_heap = true;

 	_heap = Traits::createHeap(*_heap_cross_ref);

       }

     }

   public :

     /// \name Named template parameters

     ///@{

     template <class T>

     struct DefPredMapTraits : public Traits {

       typedef T PredMap;

       static PredMap *createPredMap(const Graph& graph) {

 	throw UninitializedParameter();

       }

     };

     /// \brief \ref named-templ-param "Named parameter" for setting PredMap 

     /// type

     /// \ref named-templ-param "Named parameter" for setting PredMap type

     ///

     template <class T>

     struct DefPredMap 

       : public Johnson< Graph, LengthMap, DefPredMapTraits<T> > {

       typedef Johnson< Graph, LengthMap, DefPredMapTraits<T> > Create;

     };

     template <class T>

     struct DefDistMapTraits : public Traits {

       typedef T DistMap;

       static DistMap *createDistMap(const Graph& graph) {

 	throw UninitializedParameter();

       }

     };

     /// \brief \ref named-templ-param "Named parameter" for setting DistMap 

     /// type

     ///

     /// \ref named-templ-param "Named parameter" for setting DistMap type

     ///

     template <class T>

     struct DefDistMap 

       : public Johnson< Graph, LengthMap, DefDistMapTraits<T> > {

       typedef Johnson< Graph, LengthMap, DefDistMapTraits<T> > Create;

     };

     template <class T>

     struct DefOperationTraitsTraits : public Traits {

       typedef T OperationTraits;

     };

     /// \brief \ref named-templ-param "Named parameter" for setting 

     /// OperationTraits type

     ///

     /// \ref named-templ-param "Named parameter" for setting 

     /// OperationTraits type

     template <class T>

     struct DefOperationTraits

       : public Johnson< Graph, LengthMap, DefOperationTraitsTraits<T> > {

       typedef Johnson< Graph, LengthMap, DefOperationTraitsTraits<T> > Create;

     };

     template <class H, class CR>

     struct DefHeapTraits : public Traits {

       typedef CR HeapCrossRef;

       typedef H Heap;

       static HeapCrossRef *createHeapCrossRef(const Graph &) {

 	throw UninitializedParameter();

       }

       static Heap *createHeap(HeapCrossRef &) 

       {

 	throw UninitializedParameter();

       }

     };

     ///\brief \ref named-templ-param "Named parameter" for setting heap and 

     ///cross reference type

     ///\ref named-templ-param "Named parameter" for setting heap and cross 

     ///reference type

     ///

     template <class H, class CR = typename Graph::template NodeMap<int> >

     struct DefHeap

       : public Johnson< Graph, LengthMap, DefHeapTraits<H, CR> > { 

       typedef Johnson< Graph, LengthMap, DefHeapTraits<H, CR> > Create;

     };

     template <class H, class CR>

     struct DefStandardHeapTraits : public Traits {

       typedef CR HeapCrossRef;

       typedef H Heap;

       static HeapCrossRef *createHeapCrossRef(const Graph &G) {

 	return new HeapCrossRef(G);

       }

       static Heap *createHeap(HeapCrossRef &R) 

       {

 	return new Heap(R);

       }

     };

     ///\ref named-templ-param "Named parameter" for setting heap and cross 

     ///reference type with automatic allocation

     ///\ref named-templ-param "Named parameter" for setting heap and cross 

     ///reference type. It can allocate the heap and the cross reference 

     ///object if the cross reference's constructor waits for the graph as 

     ///parameter and the heap's constructor waits for the cross reference.

     template <class H, class CR = typename Graph::template NodeMap<int> >

     struct DefStandardHeap

       : public Johnson< Graph, LengthMap, DefStandardHeapTraits<H, CR> > { 

       typedef Johnson< Graph, LengthMap, DefStandardHeapTraits<H, CR> > 

       Create;

     };

     ///@}

   protected:

     Johnson() {}

   public:      

     typedef Johnson Create;

     /// \brief Constructor.

     ///

     /// \param _graph the graph the algorithm will run on.

     /// \param _length the length map used by the algorithm.

     Johnson(const Graph& _graph, const LengthMap& _length) :

       graph(&_graph), length(&_length),

       _pred(0), local_pred(false),

       _dist(0), local_dist(false),

       _heap_cross_ref(0), local_heap_cross_ref(false),

       _heap(0), local_heap(false) {}

     ///Destructor.

     ~Johnson() {

       if (local_pred) delete _pred;

       if (local_dist) delete _dist;

       if (local_heap_cross_ref) delete _heap_cross_ref;

       if (local_heap) delete _heap;

     }

     /// \brief Sets the length map.

     ///

     /// Sets the length map.

     /// \return \c (*this)

     Johnson &lengthMap(const LengthMap &m) {

       length = &m;

       return *this;

     }

     /// \brief Sets the map storing the predecessor edges.

     ///

     /// Sets the map storing the predecessor edges.

     /// If you don't use this function before calling \ref run(),

     /// it will allocate one. The destuctor deallocates this

     /// automatically allocated map, of course.

     /// \return \c (*this)

     Johnson &predMap(PredMap &m) {

       if(local_pred) {

 	delete _pred;

 	local_pred=false;

       }

       _pred = &m;

       return *this;

     }

     /// \brief Sets the map storing the distances calculated by the algorithm.

     ///

     /// Sets the map storing the distances calculated by the algorithm.

     /// If you don't use this function before calling \ref run(),

     /// it will allocate one. The destuctor deallocates this

     /// automatically allocated map, of course.

     /// \return \c (*this)

     Johnson &distMap(DistMap &m) {

       if(local_dist) {

 	delete _dist;

 	local_dist=false;

       }

       _dist = &m;

       return *this;

     }

   public:    

     ///\name Execution control

     /// The simplest way to execute the algorithm is to use

     /// one of the member functions called \c run(...).

     /// \n

     /// If you need more control on the execution,

     /// Finally \ref start() will perform the actual path

     /// computation.

     ///@{

     /// \brief Initializes the internal data structures.

     /// 

     /// Initializes the internal data structures.

     void init() {

       create_maps();

     }

     /// \brief Executes the algorithm with own potential map.

     ///

     /// This method runs the %Johnson algorithm in order to compute 

     /// the shortest path to each node pairs. The potential map

     /// can be given for this algorithm which usually calculated

     /// by the Bellman-Ford algorithm. If the graph does not have

     /// negative length edge then this start function can be used

     /// with constMap<Node, int>(0) parameter to omit the running time of

     /// the Bellman-Ford. 

     /// The algorithm computes 

     /// - The shortest path tree for each node.

     /// - The distance between each node pairs.

     template <typename PotentialMap>

     void shiftedStart(const PotentialMap& potential) {      

       typename Graph::template EdgeMap<Value> shiftlen(*graph);

       for (EdgeIt it(*graph);  it != INVALID; ++it) {

       	shiftlen[it] = (*length)[it] 

 	  + potential[graph->source(it)] 

 	  - potential[graph->target(it)];

       }

       typename Dijkstra<Graph, typename Graph::template EdgeMap<Value> >::

 	template DefHeap<Heap, HeapCrossRef>::

 	Create dijkstra(*graph, shiftlen);

       dijkstra.heap(*_heap, *_heap_cross_ref);

       for (NodeIt it(*graph); it != INVALID; ++it) {

 	dijkstra.run(it);

 	for (NodeIt jt(*graph); jt != INVALID; ++jt) {

 	  if (dijkstra.reached(jt)) {

 	    _dist->set(it, jt, dijkstra.dist(jt) + 

 		       potential[jt] - potential[it]);

 	    _pred->set(it, jt, dijkstra.predEdge(jt));

 	  } else {

 	    _dist->set(it, jt, OperationTraits::infinity());

 	    _pred->set(it, jt, INVALID);

 	  }

 	}

       }

     }

     /// \brief Executes the algorithm.

     ///

     /// This method runs the %Johnson algorithm in order to compute 

     /// the shortest path to each node pairs. The algorithm 

     /// computes 

     /// - The shortest path tree for each node.

     /// - The distance between each node pairs.

     void start() {

       typedef typename BellmanFord<Graph, LengthMap>::

       template DefOperationTraits<OperationTraits>::

       template DefPredMap<NullMap<Node, Edge> >::

       Create BellmanFordType;

       BellmanFordType bellmanford(*graph, *length);

       NullMap<Node, Edge> predMap;

       bellmanford.predMap(predMap);

       bellmanford.init(OperationTraits::zero());

       bellmanford.start();

       shiftedStart(bellmanford.distMap());

     }

     /// \brief Executes the algorithm and checks the negatvie cycles.

     ///

     /// This method runs the %Johnson algorithm in order to compute 

     /// the shortest path to each node pairs. If the graph contains

     /// negative cycle it gives back false. The algorithm 

     /// computes 

     /// - The shortest path tree for each node.

     /// - The distance between each node pairs.

     bool checkedStart() {

       typedef typename BellmanFord<Graph, LengthMap>::

       template DefOperationTraits<OperationTraits>::

       template DefPredMap<NullMap<Node, Edge> >::

       Create BellmanFordType;

       BellmanFordType bellmanford(*graph, *length);

       NullMap<Node, Edge> predMap;

       bellmanford.predMap(predMap);

       bellmanford.init(OperationTraits::zero());

       if (!bellmanford.checkedStart()) return false;

       shiftedStart(bellmanford.distMap());

       return true;

     }

     /// \brief Runs %Johnson algorithm.

     ///    

     /// This method runs the %Johnson algorithm from a each node

     /// in order to compute the shortest path to each node pairs. 

     /// The algorithm computes

     /// - The shortest path tree for each node.

     /// - The distance between each node pairs.

     ///

     /// \note d.run(s) is just a shortcut of the following code.

     /// \code

     ///  d.init();

     ///  d.start();

     /// \endcode

     void run() {

       init();

       start();

     }

     ///@}

     /// \name Query Functions

     /// The result of the %Johnson algorithm can be obtained using these

     /// functions.\n

     /// Before the use of these functions,

     /// either run() or start() must be called.

     ///@{

     /// \brief Copies the shortest path to \c t into \c p

     ///    

     /// This function copies the shortest path to \c t into \c p.

     /// If it \c t is a source itself or unreachable, then it does not

     /// alter \c p.

     /// \return Returns \c true if a path to \c t was actually copied to \c p,

     /// \c false otherwise.

     /// \sa DirPath

     template <typename Path>

     bool getPath(Path &p, Node source, Node target) {

       if (connected(source, target)) {

 	p.clear();

 	typename Path::Builder b(target);

 	for(b.setStartNode(target); predEdge(source, target) != INVALID;

 	    target = predNode(target)) {

 	  b.pushFront(predEdge(source, target));

 	}

 	b.commit();

 	return true;

       }

       return false;

     }

     /// \brief The distance between two nodes.

     ///

     /// Returns the distance between two nodes.

     /// \pre \ref run() must be called before using this function.

     /// \warning If node \c v in unreachable from the root the return value

     /// of this funcion is undefined.

     Value dist(Node source, Node target) const { 

       return (*_dist)(source, target); 

     }

     /// \brief Returns the 'previous edge' of the shortest path tree.

     ///

     /// For the node \c node it returns the 'previous edge' of the shortest 

     /// path tree to direction of the node \c root 

     /// i.e. it returns the last edge of a shortest path from the node \c root 

     /// to \c node. It is \ref INVALID if \c node is unreachable from the root

     /// or if \c node=root. The shortest path tree used here is equal to the 

     /// shortest path tree used in \ref predNode(). 

     /// \pre \ref run() must be called before using this function.

     Edge predEdge(Node root, Node node) const { 

       return (*_pred)(root, node); 

     }

     /// \brief Returns the 'previous node' of the shortest path tree.

     ///

     /// For a node \c node it returns the 'previous node' of the shortest path 

     /// tree to direction of the node \c root, i.e. it returns the last but 

     /// one node from a shortest path from the \c root to \c node. It is 

     /// INVALID if \c node is unreachable from the root or if \c node=root. 

     /// The shortest path tree used here is equal to the 

     /// shortest path tree used in \ref predEdge().  

     /// \pre \ref run() must be called before using this function.

     Node predNode(Node root, Node node) const { 

       return (*_pred)(root, node) == INVALID ? 

       INVALID : graph->source((*_pred)(root, node)); 

     }

     /// \brief Returns a reference to the matrix node map of distances.

     ///

     /// Returns a reference to the matrix node map of distances. 

     ///

     /// \pre \ref run() must be called before using this function.

     const DistMap &distMap() const { return *_dist;}

     /// \brief Returns a reference to the shortest path tree map.

     ///

     /// Returns a reference to the matrix node map of the edges of the

     /// shortest path tree.

     /// \pre \ref run() must be called before using this function.

     const PredMap &predMap() const { return *_pred;}

     /// \brief Checks if a node is reachable from the root.

     ///

     /// Returns \c true if \c v is reachable from the root.

     /// \pre \ref run() must be called before using this function.

     ///

     bool connected(Node source, Node target) { 

       return (*_dist)(source, target) != OperationTraits::infinity(); 

     }

     ///@}

   };

 } //END OF NAMESPACE LEMON

 #endif