RhodeCode

/* -*- mode: C++; indent-tabs-mode: nil; -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library.

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

///\ingroup demos

///\file

///\brief Demonstrating graph input and output

///

/// This program gives an example of how to read and write a digraph

/// and additional maps from/to a stream or a file using the

/// \ref lgf-format "LGF" format.

///

/// The \c "digraph.lgf" file:

/// \include digraph.lgf

///

/// And the program which reads it and prints the digraph to the

/// standard output:

/// \include lgf_demo.cc

#include <iostream>

#include <lemon/smart_graph.h>

#include <lemon/lgf_reader.h>

#include <lemon/lgf_writer.h>

using namespace lemon;

int main() {

  SmartDigraph g;

  SmartDigraph::ArcMap<int> cap(g);

  SmartDigraph::Node s, t;

  try {

    digraphReader("digraph.lgf", g). // read the directed graph into g

      arcMap("capacity", cap).       // read the 'capacity' arc map into cap

      node("source", s).             // read 'source' node to s

      node("target", t).             // read 'target' node to t

      run();

    std::cerr << "Error: " << error.what() << std::endl;

    return -1;

  }

  std::cout << "A digraph is read from 'digraph.lgf'." << std::endl;

  std::cout << "Number of nodes: " << countNodes(g) << std::endl;

  std::cout << "Number of arcs: " << countArcs(g) << std::endl;

  std::cout << "We can write it to the standard output:" << std::endl;

  digraphWriter(std::cout, g).     // write g to the standard output

    arcMap("capacity", cap).       // write cap into 'capacity'

    node("source", s).             // write s to 'source'

    node("target", t).             // write t to 'target'

    run();

  return 0;

}

    ///Constructor

    ArgParser(int argc, const char **argv);

    ~ArgParser();

    ///\name Options

    ///

    ///@{

    ///Add a new integer type option

    ///Add a new integer type option.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param value A default value for the option.

    ///\param obl Indicate if the option is mandatory.

    ArgParser &intOption(const std::string &name,

                    const std::string &help,

                    int value=0, bool obl=false);

    ///Add a new floating point type option

    ///Add a new floating point type option.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param value A default value for the option.

    ///\param obl Indicate if the option is mandatory.

    ArgParser &doubleOption(const std::string &name,

                      const std::string &help,

                      double value=0, bool obl=false);

    ///Add a new bool type option

    ///Add a new bool type option.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param value A default value for the option.

    ///\param obl Indicate if the option is mandatory.

    ///\note A mandatory bool obtion is of very little use.

    ArgParser &boolOption(const std::string &name,

                      const std::string &help,

                      bool value=false, bool obl=false);

    ///Add a new string type option

    ///Add a new string type option.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param value A default value for the option.

    ///\param obl Indicate if the option is mandatory.

    ArgParser &stringOption(const std::string &name,

                      const std::string &help,

                      std::string value="", bool obl=false);

    ///Give help string for non-parsed arguments.

    ///With this function you can give help string for non-parsed arguments.

    ///The parameter \c name will be printed in the short usage line, while

    ///\c help gives a more detailed description.

    ArgParser &other(const std::string &name,

                     const std::string &help="");

    ///@}

    ///\name Options with External Storage

    ///Using this functions, the value of the option will be directly written

    ///into a variable once the option appears in the command line.

    ///@{

    ///Add a new integer type option with a storage reference

    ///Add a new integer type option with a storage reference.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param obl Indicate if the option is mandatory.

    ///\retval ref The value of the argument will be written to this variable.

    ArgParser &refOption(const std::string &name,

                    const std::string &help,

                    int &ref, bool obl=false);

    ///Add a new floating type option with a storage reference

    ///Add a new floating type option with a storage reference.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param obl Indicate if the option is mandatory.

    ///\retval ref The value of the argument will be written to this variable.

    ArgParser &refOption(const std::string &name,

                      const std::string &help,

                      double &ref, bool obl=false);

    ///Add a new bool type option with a storage reference

    ///Add a new bool type option with a storage reference.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param obl Indicate if the option is mandatory.

    ///\retval ref The value of the argument will be written to this variable.

    ///\note A mandatory bool obtion is of very little use.

    ArgParser &refOption(const std::string &name,

                      const std::string &help,

                      bool &ref, bool obl=false);

    ///Add a new string type option with a storage reference

    ///Add a new string type option with a storage reference.

    ///\param name The name of the option. The leading '-' must be omitted.

    ///\param help A help string.

    ///\param obl Indicate if the option is mandatory.

    ///\retval ref The value of the argument will be written to this variable.

    ArgParser &refOption(const std::string &name,

                      const std::string &help,

                      std::string &ref, bool obl=false);

    ///@}

    ///\name Option Groups and Synonyms

    ///

    ///@{

    ///Bundle some options into a group

    /// You can group some option by calling this function repeatedly for each

    /// option to be grouped with the same groupname.

    ///\param group The group name.

    ///\param opt The option name.

    ArgParser &optionGroup(const std::string &group,

                           const std::string &opt);

    ///Make the members of a group exclusive

    ///If you call this function for a group, than at most one of them can be

    ///given at the same time.

    ArgParser &onlyOneGroup(const std::string &group);

    ///Make a group mandatory

    ///Using this function, at least one of the members of \c group

    ///must be given.

    ArgParser &mandatoryGroup(const std::string &group);

    ///Create synonym to an option

    ///With this function you can create a synonym \c syn of the

    ///option \c opt.

    ArgParser &synonym(const std::string &syn,

                           const std::string &opt);

    ///@}

  private:

    void show(std::ostream &os,Opts::const_iterator i) const;

    void show(std::ostream &os,Groups::const_iterator i) const;

    void showHelp(Opts::const_iterator i) const;

    void showHelp(std::vector<OtherArg>::const_iterator i) const;

    void unknownOpt(std::string arg) const;

    void requiresValue(std::string arg, OptType t) const;

    void checkMandatories() const;

    void shortHelp() const;

    void showHelp() const;

  public:

    ///Start the parsing process

    ArgParser &parse();

    /// Synonym for parse()

    ArgParser &run()

    {

      return parse();

    }

    ///Give back the command name (the 0th argument)

    const std::string &commandName() const { return _command_name; }

    ///Check if an opion has been given to the command.

    bool given(std::string op) const

    {

      Opts::const_iterator i = _opts.find(op);

      return i!=_opts.end()?i->second.set:false;

    }

    ///Magic type for operator[]

    ///This is the type of the return value of ArgParser::operator[]().

    ///It automatically converts to \c int, \c double, \c bool or

    class RefType

    {

      const ArgParser &_parser;

      std::string _name;

    public:

      ///\e

      RefType(const ArgParser &p,const std::string &n) :_parser(p),_name(n) {}

      ///\e

      operator bool()

      {

        Opts::const_iterator i = _parser._opts.find(_name);

        LEMON_ASSERT(i!=_parser._opts.end(),

                     std::string()+"Unkown option: '"+_name+"'");

        LEMON_ASSERT(i->second.type==ArgParser::BOOL,

                     std::string()+"'"+_name+"' is a bool option");

        return *(i->second.bool_p);

      }

      ///\e

      operator std::string()

      {

        Opts::const_iterator i = _parser._opts.find(_name);

        LEMON_ASSERT(i!=_parser._opts.end(),

                     std::string()+"Unkown option: '"+_name+"'");

        LEMON_ASSERT(i->second.type==ArgParser::STRING,

                     std::string()+"'"+_name+"' is a string option");

        return *(i->second.string_p);

      }

      ///\e

      operator double()

      {

        Opts::const_iterator i = _parser._opts.find(_name);

        LEMON_ASSERT(i!=_parser._opts.end(),

                     std::string()+"Unkown option: '"+_name+"'");

        LEMON_ASSERT(i->second.type==ArgParser::DOUBLE ||

                     i->second.type==ArgParser::INTEGER,

                     std::string()+"'"+_name+"' is a floating point option");

        return i->second.type==ArgParser::DOUBLE ?

          *(i->second.double_p) : *(i->second.int_p);

      }

      ///\e

      operator int()

      {

        Opts::const_iterator i = _parser._opts.find(_name);

        LEMON_ASSERT(i!=_parser._opts.end(),

                     std::string()+"Unkown option: '"+_name+"'");

        LEMON_ASSERT(i->second.type==ArgParser::INTEGER,

                     std::string()+"'"+_name+"' is an integer option");

        return *(i->second.int_p);

      }

    };

    ///Give back the value of an option

    ///Give back the value of an option.

    ///\sa RefType

    RefType operator[](const std::string &n) const

    {

      return RefType(*this, n);

    }

    ///Give back the non-option type arguments.

    ///Give back a reference to a vector consisting of the program arguments

    ///not starting with a '-' character.

    const std::vector<std::string> &files() const { return _file_args; }

  };

}

#endif // LEMON_ARG_PARSER_H

/* -*- mode: C++; indent-tabs-mode: nil; -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library.

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_ASSERT_H

#define LEMON_ASSERT_H

/// \ingroup exceptions

/// \file

/// \brief Extended assertion handling

#include <lemon/error.h>

namespace lemon {

  inline void assert_fail_abort(const char *file, int line,

                                const char *function, const char* message,

                                const char *assertion)

  {

    std::cerr << file << ":" << line << ": ";

    if (function)

      std::cerr << function << ": ";

    std::cerr << message;

    if (assertion)

      std::cerr << " (assertion '" << assertion << "' failed)";

    std::cerr << std::endl;

    std::abort();

  }

  namespace _assert_bits {

    inline const char* cstringify(const std::string& str) {

      return str.c_str();

    }

    inline const char* cstringify(const char* str) {

      return str;

    }

  }

}

#endif // LEMON_ASSERT_H

#undef LEMON_ASSERT

#undef LEMON_DEBUG

#if (defined(LEMON_ASSERT_ABORT) ? 1 : 0) +               \

  (defined(LEMON_ASSERT_CUSTOM) ? 1 : 0) > 1

#error "LEMON assertion system is not set properly"

#endif

#if ((defined(LEMON_ASSERT_ABORT) ? 1 : 0) +            \

     (defined(LEMON_ASSERT_CUSTOM) ? 1 : 0) == 1 ||     \

     defined(LEMON_ENABLE_ASSERTS)) &&                  \

  (defined(LEMON_DISABLE_ASSERTS) ||                    \

   defined(NDEBUG))

#error "LEMON assertion system is not set properly"

#endif

#if defined LEMON_ASSERT_ABORT

#  undef LEMON_ASSERT_HANDLER

#  define LEMON_ASSERT_HANDLER ::lemon::assert_fail_abort

#elif defined LEMON_ASSERT_CUSTOM

#  undef LEMON_ASSERT_HANDLER

#  ifndef LEMON_CUSTOM_ASSERT_HANDLER

#    error "LEMON_CUSTOM_ASSERT_HANDLER is not set"

#  endif

#  define LEMON_ASSERT_HANDLER LEMON_CUSTOM_ASSERT_HANDLER

#elif defined LEMON_DISABLE_ASSERTS

#  undef LEMON_ASSERT_HANDLER

#elif defined NDEBUG

#  undef LEMON_ASSERT_HANDLER

#else

#  define LEMON_ASSERT_HANDLER ::lemon::assert_fail_abort

#endif

#ifndef LEMON_FUNCTION_NAME

#  if defined __GNUC__

#    define LEMON_FUNCTION_NAME (__PRETTY_FUNCTION__)

#  elif defined _MSC_VER

#    define LEMON_FUNCTION_NAME (__FUNCSIG__)

#  elif __STDC_VERSION__ >= 199901L

#    define LEMON_FUNCTION_NAME (__func__)

#  else

#    define LEMON_FUNCTION_NAME ("<unknown>")

#  endif

#endif

#ifdef DOXYGEN

/// \ingroup exceptions

///

/// \brief Macro for assertion with customizable message

///

/// \param exp An expression that must be convertible to \c bool.  If it is \c

/// false, then an assertion is raised. The concrete behaviour depends on the

/// settings of the assertion system.

/// \param msg A <tt>const char*</tt> parameter, which can be used to provide

/// information about the circumstances of the failed assertion.

///

/// The assertions are enabled in the default behaviour.

/// You can disable them with the following code:

/// \code

/// #define LEMON_DISABLE_ASSERTS

/// \endcode

/// or with compilation parameters:

/// \code

/// g++ -DLEMON_DISABLE_ASSERTS

/// make CXXFLAGS='-DLEMON_DISABLE_ASSERTS'

/// \endcode

/// The checking is also disabled when the standard macro \c NDEBUG is defined.

///

/// As a default behaviour the failed assertion prints a short log message to

/// the standard error and aborts the execution.

///

/// However, the following modes can be used in the assertion system:

/// - \c LEMON_ASSERT_ABORT The failed assertion prints a short log message to

///   the standard error and aborts the program. It is the default behaviour.

/// - \c LEMON_ASSERT_CUSTOM The user can define own assertion handler

///   function.

///   \code

///     void custom_assert_handler(const char* file, int line,

///                                const char* function, const char* message,

///                                const char* assertion);

///   \endcode

///   The name of the function should be defined as the \c

///   LEMON_CUSTOM_ASSERT_HANDLER macro name.

///   \code

///     #define LEMON_CUSTOM_ASSERT_HANDLER custom_assert_handler

///   \endcode

///   Whenever an assertion is occured, the custom assertion

///   handler is called with appropiate parameters.

///

/// The assertion mode can also be changed within one compilation unit.

/// If the macros are redefined with other settings and the

/// \ref lemon/assert.h "assert.h" file is reincluded, then the

/// behaviour is changed appropiately to the new settings.

#  define LEMON_ASSERT(exp, msg)                                        \

  (static_cast<void> (!!(exp) ? 0 : (                                   \

    LEMON_ASSERT_HANDLER(__FILE__, __LINE__,                            \

                         LEMON_FUNCTION_NAME,                           \

                         ::lemon::_assert_bits::cstringify(msg), #exp), 0)))

/// \ingroup exceptions

///

/// \brief Macro for internal assertions

///

/// Macro for internal assertions, it is used in the library to check

/// the consistency of results of algorithms, several pre- and

/// postconditions and invariants. The checking is disabled by

/// default, but it can be turned on with the macro \c

/// LEMON_ENABLE_DEBUG.

/// \code

/// #define LEMON_ENABLE_DEBUG

/// \endcode

/// or with compilation parameters:

/// \code

/// g++ -DLEMON_ENABLE_DEBUG

/// make CXXFLAGS='-DLEMON_ENABLE_DEBUG'

/// \endcode

///

/// This macro works like the \c LEMON_ASSERT macro, therefore the

/// current behaviour depends on the settings of \c LEMON_ASSERT

/// macro.

///

/// \see LEMON_ASSERT

#  define LEMON_DEBUG(exp, msg)                                         \

  (static_cast<void> (!!(exp) ? 0 : (                                   \

    LEMON_ASSERT_HANDLER(__FILE__, __LINE__,                            \

                         LEMON_FUNCTION_NAME,                           \

                         ::lemon::_assert_bits::cstringify(msg), #exp), 0)))

#else

#  ifndef LEMON_ASSERT_HANDLER

#    define LEMON_ASSERT(exp, msg)  (static_cast<void>(0))

#    define LEMON_DEBUG(exp, msg) (static_cast<void>(0))

#  else

#    define LEMON_ASSERT(exp, msg)                                      \

       (static_cast<void> (!!(exp) ? 0 : (                              \

        LEMON_ASSERT_HANDLER(__FILE__, __LINE__,                        \

                             LEMON_FUNCTION_NAME,                       \

                             ::lemon::_assert_bits::cstringify(msg),    \

                             #exp), 0)))

#    if LEMON_ENABLE_DEBUG

#      define LEMON_DEBUG(exp, msg)                                     \

         (static_cast<void> (!!(exp) ? 0 : (                            \

           LEMON_ASSERT_HANDLER(__FILE__, __LINE__,                     \

                                LEMON_FUNCTION_NAME,                    \

                                ::lemon::_assert_bits::cstringify(msg), \

                                #exp), 0)))

#    else

#      define LEMON_DEBUG(exp, msg) (static_cast<void>(0))

#    endif

#  endif

#endif

/* -*- mode: C++; indent-tabs-mode: nil; -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library.

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_BFS_H

#define LEMON_BFS_H

///\ingroup search

///\file

///\brief BFS algorithm.

#include <lemon/list_graph.h>

#include <lemon/bits/path_dump.h>

#include <lemon/core.h>

#include <lemon/error.h>

#include <lemon/maps.h>

#include <lemon/path.h>

namespace lemon {

  ///Default traits class of Bfs class.

  ///Default traits class of Bfs class.

  ///\tparam GR Digraph type.

  template<class GR>

  struct BfsDefaultTraits

  {

    ///The type of the digraph the algorithm runs on.

    typedef GR Digraph;

    ///\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.

    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;

    ///Instantiates a \ref PredMap.

    ///This function instantiates a \ref PredMap.

    ///\param g is the digraph, to which we would like to define the

    ///\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 \ref ProcessedMap.

    ///This function instantiates a \ref ProcessedMap.

    ///\param g is the digraph, to which

    ///we would like to define the \ref ProcessedMap

#ifdef DOXYGEN

    static ProcessedMap *createProcessedMap(const Digraph &g)

#else

    static ProcessedMap *createProcessedMap(const Digraph &)

#endif

    {

      return new 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.

    typedef typename Digraph::template NodeMap<bool> ReachedMap;

    ///Instantiates a \ref ReachedMap.

    ///This function instantiates a \ref ReachedMap.

    ///\param g is the digraph, to which

    ///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 \ref DistMap.

    ///This function instantiates a \ref DistMap.

    ///\param g is the digraph, to which we would like to define the

    ///\ref DistMap.

    static DistMap *createDistMap(const Digraph &g)

    {

      return new DistMap(g);

    }

  };

  ///%BFS algorithm class.

  ///\ingroup search

  ///This class provides an efficient implementation of the %BFS algorithm.

  ///

  ///There is also a \ref bfs() "function-type interface" for the BFS

  ///algorithm, which is convenient in the simplier cases and it can be

  ///used easier.

  ///

  ///\tparam GR The type of the digraph the algorithm runs on.

  ///The default value is \ref ListDigraph. The value of GR is not used

  ///directly by \ref Bfs, it is only passed to \ref BfsDefaultTraits.

  ///\tparam TR Traits class to set various data types used by the algorithm.

  ///The default traits class is

  ///\ref BfsDefaultTraits "BfsDefaultTraits<GR>".

  ///See \ref BfsDefaultTraits for the documentation of

  ///a Bfs traits class.

#ifdef DOXYGEN

  template <typename GR,

            typename TR>

#else

  template <typename GR=ListDigraph,

            typename TR=BfsDefaultTraits<GR> >

#endif

  class Bfs {

  public:

    ///The type of the digraph the algorithm runs on.

    typedef typename TR::Digraph Digraph;

    ///\brief The type of the map that stores the predecessor arcs of the

    ///shortest paths.

    typedef typename TR::PredMap PredMap;

    ///The type of the map that stores the distances of the nodes.

    typedef typename TR::DistMap DistMap;

    ///The type of the map that indicates which nodes are reached.

    typedef typename TR::ReachedMap ReachedMap;

    ///The type of the map that indicates which nodes are processed.

    typedef typename TR::ProcessedMap ProcessedMap;

    ///The type of the paths.

    typedef PredMapPath<Digraph, PredMap> Path;

    ///The traits class.

    typedef TR Traits;

  private:

    typedef typename Digraph::Node Node;

    typedef typename Digraph::NodeIt NodeIt;

    typedef typename Digraph::Arc Arc;

    typedef typename Digraph::OutArcIt OutArcIt;

    //Pointer to the underlying digraph.

    const Digraph *G;

    //Pointer to the map of predecessor arcs.

    PredMap *_pred;

    //Indicates if _pred is locally allocated (true) or not.

    bool local_pred;

    //Pointer to the map of distances.

    DistMap *_dist;

    //Indicates if _dist is locally allocated (true) or not.

    bool local_dist;

    //Pointer to the map of reached status of the nodes.

    ReachedMap *_reached;

    //Indicates if _reached is locally allocated (true) or not.

    bool local_reached;

    //Pointer to the map of processed status of the nodes.

    ProcessedMap *_processed;

    //Indicates if _processed is locally allocated (true) or not.

    bool local_processed;

    std::vector<typename Digraph::Node> _queue;

    int _queue_head,_queue_tail,_queue_next_dist;

    int _curr_dist;

    //Creates the maps if necessary.

    void create_maps()

    {

      if(!_pred) {

        local_pred = true;

        _pred = Traits::createPredMap(*G);

      }

      if(!_dist) {

        local_dist = true;

        _dist = Traits::createDistMap(*G);

      }

      if(!_reached) {

        local_reached = true;

        _reached = Traits::createReachedMap(*G);

      }

      if(!_processed) {

        local_processed = true;

        _processed = Traits::createProcessedMap(*G);

      }

    }

  protected:

    Bfs() {}

  public:

    typedef Bfs Create;

    ///\name Named template parameters

    ///@{

    template <class T>

    struct SetPredMapTraits : public Traits {

      typedef T PredMap;

      static PredMap *createPredMap(const Digraph &)

      {

      }

    };

    ///\brief \ref named-templ-param "Named parameter" for setting

    ///\ref PredMap type.

    ///

    ///\ref named-templ-param "Named parameter" for setting

    ///\ref PredMap type.

    template <class T>

    struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > {

      typedef Bfs< Digraph, SetPredMapTraits<T> > Create;

    };

    template <class T>

    struct SetDistMapTraits : public Traits {

      typedef T DistMap;

      static DistMap *createDistMap(const Digraph &)

      {

      }

    };

    ///\brief \ref named-templ-param "Named parameter" for setting

    ///\ref DistMap type.

    ///

    ///\ref named-templ-param "Named parameter" for setting

    ///\ref DistMap type.

    template <class T>

    struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > {

      typedef Bfs< Digraph, SetDistMapTraits<T> > Create;

    };

    template <class T>

    struct SetReachedMapTraits : public Traits {

      typedef T ReachedMap;

      static ReachedMap *createReachedMap(const Digraph &)

      {

      }

    };

    ///\brief \ref named-templ-param "Named parameter" for setting

    ///\ref ReachedMap type.

    ///

    ///\ref named-templ-param "Named parameter" for setting

    ///\ref ReachedMap type.

    template <class T>

    struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > {

      typedef Bfs< Digraph, SetReachedMapTraits<T> > Create;

    };

    template <class T>

    struct SetProcessedMapTraits : public Traits {

      typedef T ProcessedMap;

      static ProcessedMap *createProcessedMap(const Digraph &)

      {

      }

    };

    ///\brief \ref named-templ-param "Named parameter" for setting

    ///\ref ProcessedMap type.

    ///

    ///\ref named-templ-param "Named parameter" for setting

    ///\ref ProcessedMap type.

    template <class T>

    struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > {

      typedef Bfs< Digraph, SetProcessedMapTraits<T> > Create;

    };

    struct SetStandardProcessedMapTraits : public Traits {

      typedef typename Digraph::template NodeMap<bool> ProcessedMap;

      static ProcessedMap *createProcessedMap(const Digraph &g)

      {

        return new ProcessedMap(g);

      }

    };

    ///\brief \ref named-templ-param "Named parameter" for setting

    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.

    ///

    ///\ref named-templ-param "Named parameter" for setting

    ///\ref 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;

    };

    ///@}

  public:

    ///Constructor.

    ///Constructor.

    ///\param g The digraph the algorithm runs on.

    Bfs(const Digraph &g) :

      G(&g),

      _pred(NULL), local_pred(false),

      _dist(NULL), local_dist(false),

      _reached(NULL), local_reached(false),

      _processed(NULL), local_processed(false)

    { }

    ///Destructor.

    ~Bfs()

    {

      if(local_pred) delete _pred;

      if(local_dist) delete _dist;

      if(local_reached) delete _reached;

      if(local_processed) delete _processed;

    }

    ///Sets the map that stores the predecessor arcs.

    ///Sets the map that stores the predecessor arcs.

    ///If you don't use this function before calling \ref run(),

    ///it will allocate one. The destructor deallocates this

    ///automatically allocated map, of course.

    ///\return <tt> (*this) </tt>

    Bfs &predMap(PredMap &m)

    {

      if(local_pred) {

        delete _pred;

        local_pred=false;

      }

      _pred = &m;

      return *this;

    }

    ///Sets the map that indicates which nodes are reached.

    ///Sets the map that indicates which nodes are reached.

    ///If you don't use this function before calling \ref run(),

    ///it will allocate one. The destructor deallocates this

    ///automatically allocated map, of course.

    ///\return <tt> (*this) </tt>

    Bfs &reachedMap(ReachedMap &m)

    {

      if(local_reached) {

        delete _reached;

        local_reached=false;

      }

      _reached = &m;

      return *this;

    }

    ///Sets the map that indicates which nodes are processed.

    ///Sets the map that indicates which nodes are processed.

    ///If you don't use this function before calling \ref run(),

    ///it will allocate one. The destructor deallocates this

    ///automatically allocated map, of course.

    ///\return <tt> (*this) </tt>

    Bfs &processedMap(ProcessedMap &m)

    {

      if(local_processed) {

        delete _processed;

        local_processed=false;

      }

      _processed = &m;

      return *this;

    }

    ///Sets the map that stores the distances of the nodes.

    ///Sets the map that stores the distances of the nodes calculated by

    ///the algorithm.

    ///If you don't use this function before calling \ref run(),

    ///it will allocate one. The destructor deallocates this

    ///automatically allocated map, of course.

    ///\return <tt> (*this) </tt>

    Bfs &distMap(DistMap &m)

    {

      if(local_dist) {

        delete _dist;

        local_dist=false;

      }

      _dist = &m;

      return *this;

    }

  public:

    ///\name Execution control

    ///The simplest way to execute the algorithm is to use

    ///one of the member functions called \ref lemon::Bfs::run() "run()".

    ///\n

    ///If you need more control on the execution, first you must call

    ///\ref lemon::Bfs::init() "init()", then you can add several source

    ///nodes with \ref lemon::Bfs::addSource() "addSource()".

    ///Finally \ref lemon::Bfs::start() "start()" will perform the

    ///actual path computation.

    ///@{

    ///Initializes the internal data structures.

    ///Initializes the internal data structures.

    ///

    void init()

    {

      create_maps();

      _queue.resize(countNodes(*G));

      _queue_head=_queue_tail=0;

      _curr_dist=1;

      for ( NodeIt u(*G) ; u!=INVALID ; ++u ) {

        _pred->set(u,INVALID);

        _reached->set(u,false);

        _processed->set(u,false);

      }

    }

    ///Adds a new source node.

    ///Adds a new source node to the set of nodes to be processed.

    ///

    void addSource(Node s)

    {

      if(!(*_reached)[s])

        {

          _reached->set(s,true);

          _pred->set(s,INVALID);

          _dist->set(s,0);

          _queue[_queue_head++]=s;

          _queue_next_dist=_queue_head;

        }

    }

    ///Processes the next node.

    ///Processes the next node.

    ///

    ///\return The processed node.

    ///

    ///\pre The queue must not be empty.

    Node processNextNode()

    {

      if(_queue_tail==_queue_next_dist) {

        _curr_dist++;

        _queue_next_dist=_queue_head;

      }

      Node n=_queue[_queue_tail++];

      _processed->set(n,true);

      Node m;

      for(OutArcIt e(*G,n);e!=INVALID;++e)

        if(!(*_reached)[m=G->target(e)]) {

          _queue[_queue_head++]=m;

          _reached->set(m,true);

          _pred->set(m,e);

          _dist->set(m,_curr_dist);

        }

      return n;

    }

    ///Processes the next node.

    ///Processes the next node and checks if the given target node

    ///is reached. If the target node is reachable from the processed

    ///node, then the \c reach parameter will be set to \c true.

    ///

    ///\param target The target node.

    ///\retval reach Indicates if the target node is reached.

    ///It should be initially \c false.

    ///

    ///\return The processed node.

    ///

    }

    ///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.

    ///By default it is a NullMap.

    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;

    ///Instantiates a \ref ProcessedMap.

    ///This function instantiates a \ref ProcessedMap.

    ///\param g is the digraph, to which

    ///we would like to define the \ref ProcessedMap.

#ifdef DOXYGEN

    static ProcessedMap *createProcessedMap(const Digraph &g)

#else

    static ProcessedMap *createProcessedMap(const Digraph &)

#endif

    {

      return new 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.

    typedef typename Digraph::template NodeMap<bool> ReachedMap;

    ///Instantiates a \ref ReachedMap.

    ///This function instantiates a \ref ReachedMap.

    ///\param g is the digraph, to which

    ///we would like to define the \ref ReachedMap.

    static ReachedMap *createReachedMap(const Digraph &g)