lemon: comparison lemon/bfs.h

equal deleted inserted replaced

-:27de417382be
+:71c2b31afe10
 ///\brief The type of the map that stores the predecessor
 ///arcs of the shortest paths.
 ///
 ///The type of the map that stores the predecessor
 ///arcs of the shortest paths.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 ///Instantiates a \c PredMap.
 ///This function instantiates a \ref PredMap.
 ///\param g is the digraph, to which we would like to define the
 }
 ///The type of the map that indicates which nodes are processed.
 ///The type of the map that indicates which nodes are processed.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
+///By default it is a NullMap.
 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 ///Instantiates a \c ProcessedMap.
 ///This function instantiates a \ref ProcessedMap.
 ///\param g is the digraph, to which
 }
 ///The type of the map that indicates which nodes are reached.
 ///The type of the map that indicates which nodes are reached.
-///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
+///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 typedef typename Digraph::template NodeMap<bool> ReachedMap;
 ///Instantiates a \c ReachedMap.
 ///This function instantiates a \ref ReachedMap.
 ///\param g is the digraph, to which
 }
 ///The type of the map that stores the distances of the nodes.
 ///The type of the map that stores the distances of the nodes.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 typedef typename Digraph::template NodeMap<int> DistMap;
 ///Instantiates a \c DistMap.
 ///This function instantiates a \ref DistMap.
 ///\param g is the digraph, to which we would like to define the
 ///\brief \ref named-templ-param "Named parameter" for setting
 ///\c PredMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
 ///\c PredMap type.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 template <class T>
 struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > {
 typedef Bfs< Digraph, SetPredMapTraits<T> > Create;
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
 ///\c DistMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
 ///\c DistMap type.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 template <class T>
 struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > {
 typedef Bfs< Digraph, SetDistMapTraits<T> > Create;
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
 ///\c ReachedMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
 ///\c ReachedMap type.
-///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
+///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 template <class T>
 struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > {
 typedef Bfs< Digraph, SetReachedMapTraits<T> > Create;
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
 ///\c ProcessedMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
 ///\c ProcessedMap type.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 template <class T>
 struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > {
 typedef Bfs< Digraph, SetProcessedMapTraits<T> > Create;
 };
 ///Either \ref run(Node) "run()" or \ref start() should be called
 ///before using them.
 ///@{
-///The shortest path to a node.
+///The shortest path to the given node.
-///Returns the shortest path to a node.
+///Returns the shortest path to the given node from the root(s).
 ///
 ///\warning \c t should be reached from the root(s).
 ///
 ///\pre Either \ref run(Node) "run()" or \ref init()
 ///must be called before using this function.
 Path path(Node t) const { return Path(*G, *_pred, t); }
-///The distance of a node from the root(s).
+///The distance of the given node from the root(s).
-///Returns the distance of a node from the root(s).
+///Returns the distance of the given node from the root(s).
 ///
 ///\warning If node \c v is not reached from the root(s), then
 ///the return value of this function is undefined.
 ///
 ///\pre Either \ref run(Node) "run()" or \ref init()
 ///must be called before using this function.
 int dist(Node v) const { return (*_dist)[v]; }
-///Returns the 'previous arc' of the shortest path tree for a node.
+///\brief Returns the 'previous arc' of the shortest path tree for
+///the given node.
+///
 ///This function returns the 'previous arc' of the shortest path
 ///tree for the node \c v, i.e. it returns the last arc of a
 ///shortest path from a root to \c v. It is \c INVALID if \c v
 ///is not reached from the root(s) or if \c v is a root.
 ///
 ///The shortest path tree used here is equal to the shortest path
-///tree used in \ref predNode().
+///tree used in \ref predNode() and \ref predMap().
 ///
 ///\pre Either \ref run(Node) "run()" or \ref init()
 ///must be called before using this function.
 Arc predArc(Node v) const { return (*_pred)[v];}
-///Returns the 'previous node' of the shortest path tree for a node.
+///\brief Returns the 'previous node' of the shortest path tree for
+///the given node.
+///
 ///This function returns the 'previous node' of the shortest path
 ///tree for the node \c v, i.e. it returns the last but one node
-///from a shortest path from a root to \c v. It is \c INVALID
+///of a shortest path from a root to \c v. It is \c INVALID
 ///if \c v is not reached from the root(s) or if \c v is a root.
 ///
 ///The shortest path tree used here is equal to the shortest path
-///tree used in \ref predArc().
+///tree used in \ref predArc() and \ref predMap().
 ///
 ///\pre Either \ref run(Node) "run()" or \ref init()
 ///must be called before using this function.
 Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:
 G->source((*_pred)[v]); }
 ///\brief Returns a const reference to the node map that stores the
 ///predecessor arcs.
 ///
 ///Returns a const reference to the node map that stores the predecessor
-///arcs, which form the shortest path tree.
+///arcs, which form the shortest path tree (forest).
 ///
 ///\pre Either \ref run(Node) "run()" or \ref init()
 ///must be called before using this function.
 const PredMap &predMap() const { return *_pred;}
-///Checks if a node is reached from the root(s).
+///Checks if the given node is reached from the root(s).
 ///Returns \c true if \c v is reached from the root(s).
 ///
 ///\pre Either \ref run(Node) "run()" or \ref init()
 ///must be called before using this function.
 ///\brief The type of the map that stores the predecessor
 ///arcs of the shortest paths.
 ///
 ///The type of the map that stores the predecessor
 ///arcs of the shortest paths.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
 ///Instantiates a PredMap.
 ///This function instantiates a PredMap.
 ///\param g is the digraph, to which we would like to define the
 }
 ///The type of the map that indicates which nodes are processed.
 ///The type of the map that indicates which nodes are processed.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 ///By default it is a NullMap.
 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
 ///Instantiates a ProcessedMap.
 ///This function instantiates a ProcessedMap.
 }
 ///The type of the map that indicates which nodes are reached.
 ///The type of the map that indicates which nodes are reached.
-///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
+///It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 typedef typename Digraph::template NodeMap<bool> ReachedMap;
 ///Instantiates a ReachedMap.
 ///This function instantiates a ReachedMap.
 ///\param g is the digraph, to which
 }
 ///The type of the map that stores the distances of the nodes.
 ///The type of the map that stores the distances of the nodes.
-///It must meet the \ref concepts::WriteMap "WriteMap" concept.
+///It must conform to the \ref concepts::WriteMap "WriteMap" concept.
 typedef typename Digraph::template NodeMap<int> DistMap;
 ///Instantiates a DistMap.
 ///This function instantiates a DistMap.
 ///\param g is the digraph, to which we would like to define
 }
 ///The type of the shortest paths.
 ///The type of the shortest paths.
-///It must meet the \ref concepts::Path "Path" concept.
+///It must conform to the \ref concepts::Path "Path" concept.
 typedef lemon::Path<Digraph> Path;
 };
 /// Default traits class used by BfsWizard
-/// To make it easier to use Bfs algorithm
+/// Default traits class used by BfsWizard.
-/// we have created a wizard class.
+/// \tparam GR The type of the digraph.
-/// This \ref BfsWizard class needs default traits,
-/// as well as the \ref Bfs class.
-/// The \ref BfsWizardBase is a class to be the default traits of the
-/// \ref BfsWizard class.
 template<class GR>
 class BfsWizardBase : public BfsWizardDefaultTraits<GR>
 {
 typedef BfsWizardDefaultTraits<GR> Base;
 int *_di;
 public:
 /// Constructor.
-/// This constructor does not require parameters, therefore it initiates
+/// This constructor does not require parameters, it initiates
 /// all of the attributes to \c 0.
 BfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0),
 _dist(0), _path(0), _di(0) {}
 /// Constructor.
 template<class TR>
 class BfsWizard : public TR
 {
 typedef TR Base;
-///The type of the digraph the algorithm runs on.
 typedef typename TR::Digraph Digraph;
 typedef typename Digraph::Node Node;
 typedef typename Digraph::NodeIt NodeIt;
 typedef typename Digraph::Arc Arc;
 typedef typename Digraph::OutArcIt OutArcIt;
-///\brief The type of the map that stores the predecessor
-///arcs of the shortest paths.
 typedef typename TR::PredMap PredMap;
-///\brief The type of the map that stores the distances of the nodes.
 typedef typename TR::DistMap DistMap;
-///\brief The type of the map that indicates which nodes are reached.
 typedef typename TR::ReachedMap ReachedMap;
-///\brief The type of the map that indicates which nodes are processed.
 typedef typename TR::ProcessedMap ProcessedMap;
-///The type of the shortest paths
 typedef typename TR::Path Path;
 public:
 /// Constructor.
 struct SetPredMapBase : public Base {
 typedef T PredMap;
 static PredMap *createPredMap(const Digraph &) { return 0; };
 SetPredMapBase(const TR &b) : TR(b) {}
 };
-///\brief \ref named-func-param "Named parameter"
-///for setting PredMap object.
+///\brief \ref named-templ-param "Named parameter" for setting
-///
+///the predecessor map.
-///\ref named-func-param "Named parameter"
+///
-///for setting PredMap object.
+///\ref named-templ-param "Named parameter" function for setting
+///the map that stores the predecessor arcs of the nodes.
 template<class T>
 BfsWizard<SetPredMapBase<T> > predMap(const T &t)
 {
 Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));
 return BfsWizard<SetPredMapBase<T> >(*this);
 struct SetReachedMapBase : public Base {
 typedef T ReachedMap;
 static ReachedMap *createReachedMap(const Digraph &) { return 0; };
 SetReachedMapBase(const TR &b) : TR(b) {}
 };
-///\brief \ref named-func-param "Named parameter"
-///for setting ReachedMap object.
+///\brief \ref named-templ-param "Named parameter" for setting
-///
+///the reached map.
-/// \ref named-func-param "Named parameter"
+///
-///for setting ReachedMap object.
+///\ref named-templ-param "Named parameter" function for setting
+///the map that indicates which nodes are reached.
 template<class T>
 BfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
 {
 Base::_reached=reinterpret_cast<void*>(const_cast<T*>(&t));
 return BfsWizard<SetReachedMapBase<T> >(*this);
 struct SetDistMapBase : public Base {
 typedef T DistMap;
 static DistMap *createDistMap(const Digraph &) { return 0; };
 SetDistMapBase(const TR &b) : TR(b) {}
 };
-///\brief \ref named-func-param "Named parameter"
-///for setting DistMap object.
+///\brief \ref named-templ-param "Named parameter" for setting
-///
+///the distance map.
-/// \ref named-func-param "Named parameter"
+///
-///for setting DistMap object.
+///\ref named-templ-param "Named parameter" function for setting
+///the map that stores the distances of the nodes calculated
+///by the algorithm.
 template<class T>
 BfsWizard<SetDistMapBase<T> > distMap(const T &t)
 {
 Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));
 return BfsWizard<SetDistMapBase<T> >(*this);
 struct SetProcessedMapBase : public Base {
 typedef T ProcessedMap;
 static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
 SetProcessedMapBase(const TR &b) : TR(b) {}
 };
-///\brief \ref named-func-param "Named parameter"
-///for setting ProcessedMap object.
+///\brief \ref named-func-param "Named parameter" for setting
-///
+///the processed map.
-/// \ref named-func-param "Named parameter"
+///
-///for setting ProcessedMap object.
+///\ref named-templ-param "Named parameter" function for setting
+///the map that indicates which nodes are processed.
 template<class T>
 BfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
 {
 Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));
 return BfsWizard<SetProcessedMapBase<T> >(*this);
 typedef GR Digraph;
 /// \brief The type of the map that indicates which nodes are reached.
 ///
 /// The type of the map that indicates which nodes are reached.
-/// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
+/// It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 typedef typename Digraph::template NodeMap<bool> ReachedMap;
 /// \brief Instantiates a ReachedMap.
 ///
 /// This function instantiates a ReachedMap.
 /// Either \ref run(Node) "run()" or \ref start() should be called
 /// before using them.
 ///@{
-/// \brief Checks if a node is reached from the root(s).
+/// \brief Checks if the given node is reached from the root(s).
 ///
 /// Returns \c true if \c v is reached from the root(s).
 ///
 /// \pre Either \ref run(Node) "run()" or \ref init()
 /// must be called before using this function.

changeset 763	f47b6c94577e
parent 525	9605e051942f
child 764	684964884a2e