lemon/bfs.h
changeset 1616 78704393218d
parent 1516 4aeda8d11d5e
child 1624 61cc647dac99
equal deleted inserted replaced
1:ac13461f4a77 2:732c1b3d14bc
    82     ///\todo named parameter to set this type, function to read and write.
    82     ///\todo named parameter to set this type, function to read and write.
    83     typedef NullMap<typename Graph::Node,bool> ProcessedMap;
    83     typedef NullMap<typename Graph::Node,bool> ProcessedMap;
    84     ///Instantiates a ProcessedMap.
    84     ///Instantiates a ProcessedMap.
    85  
    85  
    86     ///This function instantiates a \ref ProcessedMap. 
    86     ///This function instantiates a \ref ProcessedMap. 
    87     ///\param G is the graph, to which
    87     ///\param g is the graph, to which
    88     ///we would like to define the \ref ProcessedMap
    88     ///we would like to define the \ref ProcessedMap
       
    89 #ifdef DOXYGEN
       
    90     static ProcessedMap *createProcessedMap(const GR &g)
       
    91 #else
    89     static ProcessedMap *createProcessedMap(const GR &)
    92     static ProcessedMap *createProcessedMap(const GR &)
       
    93 #endif
    90     {
    94     {
    91       return new ProcessedMap();
    95       return new ProcessedMap();
    92     }
    96     }
    93     ///The type of the map that indicates which nodes are reached.
    97     ///The type of the map that indicates which nodes are reached.
    94  
    98  
   657     ///@{
   661     ///@{
   658 
   662 
   659     ///Copies the shortest path to \c t into \c p
   663     ///Copies the shortest path to \c t into \c p
   660     
   664     
   661     ///This function copies the shortest path to \c t into \c p.
   665     ///This function copies the shortest path to \c t into \c p.
   662     ///If it \c \t is a source itself or unreachable, then it does not
   666     ///If \c t is a source itself or unreachable, then it does not
   663     ///alter \c p.
   667     ///alter \c p.
   664     ///\todo Is it the right way to handle unreachable nodes?
   668     ///\todo Is it the right way to handle unreachable nodes?
   665     ///\return Returns \c true if a path to \c t was actually copied to \c p,
   669     ///\return Returns \c true if a path to \c t was actually copied to \c p,
   666     ///\c false otherwise.
   670     ///\c false otherwise.
   667     ///\sa DirPath
   671     ///\sa DirPath
   768     ///
   772     ///
   769     typedef NullMap<typename Graph::Node,typename GR::Edge> PredMap;
   773     typedef NullMap<typename Graph::Node,typename GR::Edge> PredMap;
   770     ///Instantiates a PredMap.
   774     ///Instantiates a PredMap.
   771  
   775  
   772     ///This function instantiates a \ref PredMap. 
   776     ///This function instantiates a \ref PredMap. 
   773     ///\param G is the graph, to which we would like to define the PredMap.
   777     ///\param g is the graph, to which we would like to define the PredMap.
   774     ///\todo The graph alone may be insufficient to initialize
   778     ///\todo The graph alone may be insufficient to initialize
       
   779 #ifdef DOXYGEN
       
   780     static PredMap *createPredMap(const GR &g) 
       
   781 #else
   775     static PredMap *createPredMap(const GR &) 
   782     static PredMap *createPredMap(const GR &) 
       
   783 #endif
   776     {
   784     {
   777       return new PredMap();
   785       return new PredMap();
   778     }
   786     }
   779 //     ///\brief The type of the map that stores the last but one
   787 //     ///\brief The type of the map that stores the last but one
   780 //     ///nodes of the shortest paths.
   788 //     ///nodes of the shortest paths.
   801     ///\todo named parameter to set this type, function to read and write.
   809     ///\todo named parameter to set this type, function to read and write.
   802     typedef NullMap<typename Graph::Node,bool> ProcessedMap;
   810     typedef NullMap<typename Graph::Node,bool> ProcessedMap;
   803     ///Instantiates a ProcessedMap.
   811     ///Instantiates a ProcessedMap.
   804  
   812  
   805     ///This function instantiates a \ref ProcessedMap. 
   813     ///This function instantiates a \ref ProcessedMap. 
   806     ///\param G is the graph, to which
   814     ///\param g is the graph, to which
   807     ///we would like to define the \ref ProcessedMap
   815     ///we would like to define the \ref ProcessedMap
       
   816 #ifdef DOXYGEN
       
   817     static ProcessedMap *createProcessedMap(const GR &g)
       
   818 #else
   808     static ProcessedMap *createProcessedMap(const GR &)
   819     static ProcessedMap *createProcessedMap(const GR &)
       
   820 #endif
   809     {
   821     {
   810       return new ProcessedMap();
   822       return new ProcessedMap();
   811     }
   823     }
   812     ///The type of the map that indicates which nodes are reached.
   824     ///The type of the map that indicates which nodes are reached.
   813  
   825  
   831     ///
   843     ///
   832     typedef NullMap<typename Graph::Node,int> DistMap;
   844     typedef NullMap<typename Graph::Node,int> DistMap;
   833     ///Instantiates a DistMap.
   845     ///Instantiates a DistMap.
   834  
   846  
   835     ///This function instantiates a \ref DistMap. 
   847     ///This function instantiates a \ref DistMap. 
   836     ///\param G is the graph, to which we would like to define the \ref DistMap
   848     ///\param g is the graph, to which we would like to define the \ref DistMap
       
   849 #ifdef DOXYGEN
       
   850     static DistMap *createDistMap(const GR &g)
       
   851 #else
   837     static DistMap *createDistMap(const GR &)
   852     static DistMap *createDistMap(const GR &)
       
   853 #endif
   838     {
   854     {
   839       return new DistMap();
   855       return new DistMap();
   840     }
   856     }
   841   };
   857   };
   842   
   858