lemon/bfs.h
changeset 844 a6eb9698c321
parent 788 c92296660262
child 877 141f9c0db4a3
equal deleted inserted replaced
30:5378c14447a8 31:76b0452852ff
   119   ///algorithm, which is convenient in the simplier cases and it can be
   119   ///algorithm, which is convenient in the simplier cases and it can be
   120   ///used easier.
   120   ///used easier.
   121   ///
   121   ///
   122   ///\tparam GR The type of the digraph the algorithm runs on.
   122   ///\tparam GR The type of the digraph the algorithm runs on.
   123   ///The default type is \ref ListDigraph.
   123   ///The default type is \ref ListDigraph.
       
   124   ///\tparam TR The traits class that defines various types used by the
       
   125   ///algorithm. By default, it is \ref BfsDefaultTraits
       
   126   ///"BfsDefaultTraits<GR>".
       
   127   ///In most cases, this parameter should not be set directly,
       
   128   ///consider to use the named template parameters instead.
   124 #ifdef DOXYGEN
   129 #ifdef DOXYGEN
   125   template <typename GR,
   130   template <typename GR,
   126             typename TR>
   131             typename TR>
   127 #else
   132 #else
   128   template <typename GR=ListDigraph,
   133   template <typename GR=ListDigraph,
   955   /// It does not have own \ref run(Node) "run()" method, it uses the
   960   /// It does not have own \ref run(Node) "run()" method, it uses the
   956   /// functions and features of the plain \ref Bfs.
   961   /// functions and features of the plain \ref Bfs.
   957   ///
   962   ///
   958   /// This class should only be used through the \ref bfs() function,
   963   /// This class should only be used through the \ref bfs() function,
   959   /// which makes it easier to use the algorithm.
   964   /// which makes it easier to use the algorithm.
       
   965   ///
       
   966   /// \tparam TR The traits class that defines various types used by the
       
   967   /// algorithm.
   960   template<class TR>
   968   template<class TR>
   961   class BfsWizard : public TR
   969   class BfsWizard : public TR
   962   {
   970   {
   963     typedef TR Base;
   971     typedef TR Base;
   964 
   972 
  1293   /// it is only passed to \ref BfsVisitDefaultTraits.
  1301   /// it is only passed to \ref BfsVisitDefaultTraits.
  1294   /// \tparam VS The Visitor type that is used by the algorithm.
  1302   /// \tparam VS The Visitor type that is used by the algorithm.
  1295   /// \ref BfsVisitor "BfsVisitor<GR>" is an empty visitor, which
  1303   /// \ref BfsVisitor "BfsVisitor<GR>" is an empty visitor, which
  1296   /// does not observe the BFS events. If you want to observe the BFS
  1304   /// does not observe the BFS events. If you want to observe the BFS
  1297   /// events, you should implement your own visitor class.
  1305   /// events, you should implement your own visitor class.
  1298   /// \tparam TR Traits class to set various data types used by the
  1306   /// \tparam TR The traits class that defines various types used by the
  1299   /// algorithm. The default traits class is
  1307   /// algorithm. By default, it is \ref BfsVisitDefaultTraits
  1300   /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<GR>".
  1308   /// "BfsVisitDefaultTraits<GR>".
  1301   /// See \ref BfsVisitDefaultTraits for the documentation of
  1309   /// In most cases, this parameter should not be set directly,
  1302   /// a BFS visit traits class.
  1310   /// consider to use the named template parameters instead.
  1303 #ifdef DOXYGEN
  1311 #ifdef DOXYGEN
  1304   template <typename GR, typename VS, typename TR>
  1312   template <typename GR, typename VS, typename TR>
  1305 #else
  1313 #else
  1306   template <typename GR = ListDigraph,
  1314   template <typename GR = ListDigraph,
  1307             typename VS = BfsVisitor<GR>,
  1315             typename VS = BfsVisitor<GR>,