lemon: comparison lemon/bfs.h

equal deleted inserted replaced

-:d3d83066113d
+:27de417382be
 ///
 ///The type of the map that stores the predecessor
 ///arcs of the shortest paths.
 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
-///Instantiates a PredMap.
+///Instantiates a \c PredMap.
-///This function instantiates a PredMap.
+///This function instantiates a \ref PredMap.
 ///\param g is the digraph, to which we would like to define the
-///PredMap.
+///\ref PredMap.
 static PredMap *createPredMap(const Digraph &g)
 {
 return new PredMap(g);
 }
 ///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.
 typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
-///Instantiates a ProcessedMap.
+///Instantiates a \c ProcessedMap.
-///This function instantiates a ProcessedMap.
+///This function instantiates a \ref ProcessedMap.
 ///\param g is the digraph, to which
-///we would like to define the ProcessedMap
+///we would like to define the \ref ProcessedMap
 #ifdef DOXYGEN
 static ProcessedMap *createProcessedMap(const Digraph &g)
 #else
 static ProcessedMap *createProcessedMap(const Digraph &)
 #endif
 ///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.
 typedef typename Digraph::template NodeMap<bool> ReachedMap;
-///Instantiates a ReachedMap.
+///Instantiates a \c ReachedMap.
-///This function instantiates a ReachedMap.
+///This function instantiates a \ref ReachedMap.
 ///\param g is the digraph, to which
-///we would like to define the ReachedMap.
+///we would like to define the \ref ReachedMap.
 static ReachedMap *createReachedMap(const Digraph &g)
 {
 return new ReachedMap(g);
 }
 ///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.
 typedef typename Digraph::template NodeMap<int> DistMap;
-///Instantiates a DistMap.
+///Instantiates a \c DistMap.
-///This function instantiates a DistMap.
+///This function instantiates a \ref DistMap.
 ///\param g is the digraph, to which we would like to define the
-///DistMap.
+///\ref DistMap.
 static DistMap *createDistMap(const Digraph &g)
 {
 return new DistMap(g);
 }
 };
 LEMON_ASSERT(false, "PredMap is not initialized");
 return 0; // ignore warnings
 }
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
-///PredMap type.
+///\c PredMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
-///PredMap type.
+///\c PredMap type.
 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 template <class T>
 struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > {
 typedef Bfs< Digraph, SetPredMapTraits<T> > Create;
 };
 LEMON_ASSERT(false, "DistMap is not initialized");
 return 0; // ignore warnings
 }
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
-///DistMap type.
+///\c DistMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
-///DistMap type.
+///\c DistMap type.
 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 template <class T>
 struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > {
 typedef Bfs< Digraph, SetDistMapTraits<T> > Create;
 };
 LEMON_ASSERT(false, "ReachedMap is not initialized");
 return 0; // ignore warnings
 }
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
-///ReachedMap type.
+///\c ReachedMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
-///ReachedMap type.
+///\c ReachedMap type.
 ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 template <class T>
 struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > {
 typedef Bfs< Digraph, SetReachedMapTraits<T> > Create;
 };
 LEMON_ASSERT(false, "ProcessedMap is not initialized");
 return 0; // ignore warnings
 }
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
-///ProcessedMap type.
+///\c ProcessedMap type.
 ///
 ///\ref named-templ-param "Named parameter" for setting
-///ProcessedMap type.
+///\c ProcessedMap type.
 ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 template <class T>
 struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > {
 typedef Bfs< Digraph, SetProcessedMapTraits<T> > Create;
 };
 return new ProcessedMap(g);
 return 0; // ignore warnings
 }
 };
 ///\brief \ref named-templ-param "Named parameter" for setting
-///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 ///
 ///\ref named-templ-param "Named parameter" for setting
-///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
+///\c ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 ///If you don't set it explicitly, it will be automatically allocated.
 struct SetStandardProcessedMap :
 public Bfs< Digraph, SetStandardProcessedMapTraits > {
 typedef Bfs< Digraph, SetStandardProcessedMapTraits > Create;
 };
 #ifdef DOXYGEN
 /// \brief Visitor class for BFS.
 ///
 /// This class defines the interface of the BfsVisit events, and
 /// it could be the base of a real visitor class.
-template <typename _Digraph>
+template <typename GR>
 struct BfsVisitor {
-typedef _Digraph Digraph;
+typedef GR Digraph;
 typedef typename Digraph::Arc Arc;
 typedef typename Digraph::Node Node;
 /// \brief Called for the source node(s) of the BFS.
 ///
 /// This function is called for the source node(s) of the BFS.
 /// This function is called when an arc is examined but its target node is
 /// already discovered.
 void examine(const Arc& arc) {}
 };
 #else
-template <typename _Digraph>
+template <typename GR>
 struct BfsVisitor {
-typedef _Digraph Digraph;
+typedef GR Digraph;
 typedef typename Digraph::Arc Arc;
 typedef typename Digraph::Node Node;
 void start(const Node&) {}
 void reach(const Node&) {}
 void process(const Node&) {}
 #endif
 /// \brief Default traits class of BfsVisit class.
 ///
 /// Default traits class of BfsVisit class.
-/// \tparam _Digraph The type of the digraph the algorithm runs on.
+/// \tparam GR The type of the digraph the algorithm runs on.
-template<class _Digraph>
+template<class GR>
 struct BfsVisitDefaultTraits {
 /// \brief The type of the digraph the algorithm runs on.
-typedef _Digraph Digraph;
+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.
 };
 /// \ingroup search
 ///
-/// \brief %BFS algorithm class with visitor interface.
+/// \brief BFS algorithm class with visitor interface.
 ///
-/// This class provides an efficient implementation of the %BFS algorithm
+/// This class provides an efficient implementation of the BFS algorithm
 /// with visitor interface.
 ///
-/// The %BfsVisit class provides an alternative interface to the Bfs
+/// The BfsVisit class provides an alternative interface to the Bfs
 /// class. It works with callback mechanism, the BfsVisit object calls
 /// the member functions of the \c Visitor class on every BFS event.
 ///
 /// This interface of the BFS algorithm should be used in special cases
 /// when extra actions have to be performed in connection with certain
 /// events of the BFS algorithm. Otherwise consider to use Bfs or bfs()
 /// instead.
 ///
-/// \tparam _Digraph The type of the digraph the algorithm runs on.
+/// \tparam GR The type of the digraph the algorithm runs on.
-/// The default value is
+/// The default type is \ref ListDigraph.
-/// \ref ListDigraph. The value of _Digraph is not used directly by
+/// The value of GR is not used directly by \ref BfsVisit,
-/// \ref BfsVisit, it is only passed to \ref BfsVisitDefaultTraits.
+/// it is only passed to \ref BfsVisitDefaultTraits.
-/// \tparam _Visitor The Visitor type that is used by the algorithm.
+/// \tparam VS The Visitor type that is used by the algorithm.
-/// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty visitor, which
+/// \ref BfsVisitor "BfsVisitor<GR>" is an empty visitor, which
 /// does not observe the BFS events. If you want to observe the BFS
 /// events, you should implement your own visitor class.
-/// \tparam _Traits Traits class to set various data types used by the
+/// \tparam TR Traits class to set various data types used by the
 /// algorithm. The default traits class is
-/// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<_Digraph>".
+/// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<GR>".
 /// See \ref BfsVisitDefaultTraits for the documentation of
 /// a BFS visit traits class.
 #ifdef DOXYGEN
-template <typename _Digraph, typename _Visitor, typename _Traits>
+template <typename GR, typename VS, typename TR>
 #else
-template <typename _Digraph = ListDigraph,
+template <typename GR = ListDigraph,
-typename _Visitor = BfsVisitor<_Digraph>,
+typename VS = BfsVisitor<GR>,
-typename _Traits = BfsVisitDefaultTraits<_Digraph> >
+typename TR = BfsVisitDefaultTraits<GR> >
 #endif
 class BfsVisit {
 public:
 ///The traits class.
-typedef _Traits Traits;
+typedef TR Traits;
 ///The type of the digraph the algorithm runs on.
 typedef typename Traits::Digraph Digraph;
 ///The visitor type used by the algorithm.
-typedef _Visitor Visitor;
+typedef VS Visitor;
 ///The type of the map that indicates which nodes are reached.
 typedef typename Traits::ReachedMap ReachedMap;
 private:

changeset 525	9605e051942f
parent 463	88ed40ad0d4f
child 760	4ac30454f1c1
child 763	f47b6c94577e
child 1125	b873350e6258