lemon-0.x: comparison src/work/alpar/dijkstra.h

equal deleted inserted replaced

-:559ab4610e4e
+:05ef95f9a6b5
 ///\brief Dijkstra algorithm.
 #include <lemon/list_graph.h>
 #include <lemon/bin_heap.h>
 #include <lemon/invalid.h>
+#include <lemon/error.h>
+#include <lemon/maps.h>
 namespace lemon {
+class UninitializedData : public LogicError {};
 /// \addtogroup flowalgs
 /// @{
 ///Default traits class of Dijkstra class.
 ///
 typedef typename Graph::template NodeMap<typename GR::Edge> PredMap;
 ///Instantiates a PredMap.
 ///\todo Please document...
-///
+///\todo The graph alone may be insufficient for the initialization
 static PredMap *createPredMap(const GR &G)
 {
 return new PredMap(G);
 }
 ///\brief The type of the map that stores the last but one
 ///\todo Please document...
 ///
 static PredNodeMap *createPredNodeMap(const GR &G)
 {
 return new PredNodeMap(G);
+}
+///The type of the map that stores whether a nodes is reached.
+///It must meet the \ref concept::WriteMap "WriteMap" concept.
+///By default it is a NullMap.
+///\todo If it is set to a real map, Dijkstra::reached() should read this.
+///\todo named parameter to set this type, function to read and write.
+typedef NullMap<typename Graph::Node,bool> ReachedMap;
+///Instantiates a ReachedMap.
+///\todo Please document...
+///
+static ReachedMap *createReachedMap(const GR &G)
+{
+return new ReachedMap();
 }
 ///The type of the map that stores the dists of the nodes.
 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
 ///
 	    typename LM=typename GR::template EdgeMap<int>,
 	    typename TR=DijkstraDefaultTraits<GR,LM> >
 #endif
 class Dijkstra {
 public:
+///Exception thrown by dijkstra.
+class UninitializedData : public lemon::UninitializedData {};
 typedef TR Traits;
 ///The type of the underlying graph.
 typedef typename TR::Graph Graph;
 ///\e
 typedef typename Graph::Node Node;
 ///edges of the shortest paths.
 typedef typename TR::PredMap PredMap;
 ///\brief The type of the map that stores the last but one
 ///nodes of the shortest paths.
 typedef typename TR::PredNodeMap PredNodeMap;
+///The type of the map indicating if a node is reached.
+typedef typename TR::ReachedMap ReachedMap;
 ///The type of the map that stores the dists of the nodes.
 typedef typename TR::DistMap DistMap;
 ///The heap type used by the dijkstra algorithm.
 typedef typename TR::Heap Heap;
 private:
 /// Pointer to the underlying graph.
 const Graph *G;
 /// Pointer to the length map
 const LengthMap *length;
 ///Pointer to the map of predecessors edges.
-PredMap *predecessor;
+PredMap *_pred;
-///Indicates if \ref predecessor is locally allocated (\c true) or not.
+///Indicates if \ref _pred is locally allocated (\c true) or not.
-bool local_predecessor;
+bool local_pred;
 ///Pointer to the map of predecessors nodes.
 PredNodeMap *pred_node;
 ///Indicates if \ref pred_node is locally allocated (\c true) or not.
 bool local_pred_node;
 ///Pointer to the map of distances.
 DistMap *distance;
 ///Indicates if \ref distance is locally allocated (\c true) or not.
 bool local_distance;
+///Pointer to the map of reached status of the nodes.
+ReachedMap *_reached;
+///Indicates if \ref _reached is locally allocated (\c true) or not.
+bool local_reached;
 ///The source node of the last execution.
 Node source;
 ///Initializes the maps.
 ///\todo Error if \c G or are \c NULL. What about \c length?
 ///\todo Better memory allocation (instead of new).
 void init_maps()
 {
-if(!predecessor) {
+if(!_pred) {
-	local_predecessor = true;
+	local_pred = true;
-	predecessor = Traits::createPredMap(*G);
+	_pred = Traits::createPredMap(*G);
 }
 if(!pred_node) {
 	local_pred_node = true;
 	pred_node = Traits::createPredNodeMap(*G);
 }
 if(!distance) {
 	local_distance = true;
 	distance = Traits::createDistMap(*G);
+}
+if(!_reached) {
+	local_reached = true;
+	_reached = Traits::createReachedMap(*G);
 }
 }
 public :
 typedef T PredMap;
 ///\todo An exception should be thrown.
 ///
 static PredMap *createPredMap(const Graph &G)
 {
-	std::cerr << __FILE__ ":" << __LINE__ <<
+	throw UninitializedData();
-	  ": error: Special maps should be manually created" << std::endl;
-	exit(1);
 }
 };
 ///\ref named-templ-param "Named parameter" for setting PredMap type
 ///\ref named-templ-param "Named parameter" for setting PredMap type
 typedef T PredNodeMap;
 ///\todo An exception should be thrown.
 ///
 static PredNodeMap *createPredNodeMap(const Graph &G)
 {
-	std::cerr << __FILE__ ":" << __LINE__ <<
+	throw UninitializedData();
-	  ": error: Special maps should be manually created" << std::endl;
-	exit(1);
 }
 };
 ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
 ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
 typedef T DistMap;
 ///\todo An exception should be thrown.
 ///
 static DistMap *createDistMap(const Graph &G)
 {
-	std::cerr << __FILE__ ":" << __LINE__ <<
+	throw UninitializedData();
-	  ": error: Special maps should be manually created" << std::endl;
-	exit(1);
 }
 };
 ///\ref named-templ-param "Named parameter" for setting DistMap type
 ///\ref named-templ-param "Named parameter" for setting DistMap type
 ///\param _G the graph the algorithm will run on.
 ///\param _length the length map used by the algorithm.
 Dijkstra(const Graph& _G, const LengthMap& _length) :
 G(&_G), length(&_length),
-predecessor(NULL), local_predecessor(false),
+_pred(NULL), local_pred(false),
 pred_node(NULL), local_pred_node(false),
-distance(NULL), local_distance(false)
+distance(NULL), local_distance(false),
+_reached(NULL), local_reached(false)
 { }
 ///Destructor.
 ~Dijkstra()
 {
-if(local_predecessor) delete predecessor;
+if(local_pred) delete _pred;
 if(local_pred_node) delete pred_node;
 if(local_distance) delete distance;
+if(local_reached) delete _reached;
 }
 ///Sets the length map.
 ///Sets the length map.
 ///it will allocate one. The destuctor deallocates this
 ///automatically allocated map, of course.
 ///\return <tt> (*this) </tt>
 Dijkstra &predMap(PredMap &m)
 {
-if(local_predecessor) {
+if(local_pred) {
-	delete predecessor;
+	delete _pred;
-	local_predecessor=false;
+	local_pred=false;
 }
-predecessor = &m;
+_pred = &m;
 return *this;
 }
 ///Sets the map storing the predecessor nodes.
 init_maps();
 source = s;
 for ( NodeIt u(*G) ; u!=INVALID ; ++u ) {
-	predecessor->set(u,INVALID);
+	_pred->set(u,INVALID);
 	pred_node->set(u,INVALID);
+	///\todo *_reached is not set to false.
 }
 typename Graph::template NodeMap<int> heap_map(*G,-1);
 Heap heap(heap_map);
 heap.push(s,0);
 while ( !heap.empty() ) {
 	Node v=heap.top();
+	_reached->set(v,true);
 	Value oldvalue=heap[v];
 	heap.pop();
 	distance->set(v, oldvalue);
 	for(OutEdgeIt e(*G,v); e!=INVALID; ++e) {
 	  Node w=G->target(e);
 	  switch(heap.state(w)) {
 	  case Heap::PRE_HEAP:
 	    heap.push(w,oldvalue+(*length)[e]);
-	    predecessor->set(w,e);
+	    _pred->set(w,e);
 	    pred_node->set(w,v);
 	    break;
 	  case Heap::IN_HEAP:
 	    if ( oldvalue+(*length)[e] < heap[w] ) {
 	      heap.decrease(w, oldvalue+(*length)[e]);
-	      predecessor->set(w,e);
+	      _pred->set(w,e);
 	      pred_node->set(w,v);
 	    }
 	    break;
 	  case Heap::POST_HEAP:
 	    break;
 ///if \c v is unreachable from the root or if \c v=s. The
 ///shortest path tree used here is equal to the shortest path tree used in
 ///\ref predNode(Node v).  \pre \ref run() must be called before using
 ///this function.
 ///\todo predEdge could be a better name.
-Edge pred(Node v) const { return (*predecessor)[v]; }
+Edge pred(Node v) const { return (*_pred)[v]; }
 ///Returns the 'previous node' of the shortest path tree.
 ///For a node \c v it returns the 'previous node' of the shortest path tree,
 ///i.e. it returns the last but one node from a shortest path from the
 ///Returns a reference to the shortest path tree map.
 ///Returns a reference to the NodeMap of the edges of the
 ///shortest path tree.
 ///\pre \ref run() must be called before using this function.
-const PredMap &predMap() const { return *predecessor;}
+const PredMap &predMap() const { return *_pred;}
 ///Returns a reference to the map of nodes of shortest paths.
 ///Returns a reference to the NodeMap of the last but one nodes of the
 ///shortest path tree.
 ///Returns \c true if \c v is reachable from the root.
 ///\note The root node is reported to be reached!
 ///\pre \ref run() must be called before using this function.
 ///
-bool reached(Node v) { return v==source || (*predecessor)[v]!=INVALID; }
+bool reached(Node v) { return v==source || (*_pred)[v]!=INVALID; }
 };
 template<class GR,class LM>
 class DijkstraWizardBase : public DijkstraDefaultTraits<GR,LM>
 template<class TR>
 class DijkstraWizard : public TR
 {
 typedef TR Base;
-///The type of the underlying graph.
+//The type of the underlying graph.
 typedef typename TR::Graph Graph;
-///\e
+//\e
 typedef typename Graph::Node Node;
-///\e
+//\e
 typedef typename Graph::NodeIt NodeIt;
-///\e
+//\e
 typedef typename Graph::Edge Edge;
-///\e
+//\e
 typedef typename Graph::OutEdgeIt OutEdgeIt;
-///The type of the map that stores the edge lengths.
+//The type of the map that stores the edge lengths.
 typedef typename TR::LengthMap LengthMap;
-///The type of the length of the edges.
+//The type of the length of the edges.
 typedef typename LengthMap::Value Value;
-///\brief The type of the map that stores the last
+//\brief The type of the map that stores the last
-///edges of the shortest paths.
+//edges of the shortest paths.
 typedef typename TR::PredMap PredMap;
-///\brief The type of the map that stores the last but one
+//\brief The type of the map that stores the last but one
-///nodes of the shortest paths.
+//nodes of the shortest paths.
 typedef typename TR::PredNodeMap PredNodeMap;
-///The type of the map that stores the dists of the nodes.
+//The type of the map that stores the dists of the nodes.
 typedef typename TR::DistMap DistMap;
-///The heap type used by the dijkstra algorithm.
+//The heap type used by the dijkstra algorithm.
 typedef typename TR::Heap Heap;
 public:
 DijkstraWizard() : TR() {}
 DijkstraWizard(const Graph &g,const LengthMap &l, Node s=INVALID) :
 ~DijkstraWizard() {}
 ///\e
 void run()
 {
+if(_source==0) throw UninitializedData();
 Dijkstra<Graph,LengthMap,TR> Dij(*(Graph*)_g,*(LengthMap*)_length);
 if(_pred) Dij.predMap(*(PredMap*)_pred);
 if(_predNode) Dij.predNodeMap(*(PredNodeMap*)_predNode);
 if(_dist) Dij.distMap(*(DistMap*)_dist);
 Dij.run(*(Node*)_source);

changeset 1121	8f066fdf6dc9
parent 1117	5767cc417f62
child 1123	a2e93889a604