RhodeCode

CMAKE_MINIMUM_REQUIRED(VERSION 2.6)

SET(PROJECT_NAME "LEMON")

PROJECT(${PROJECT_NAME})

INCLUDE(FindPythonInterp)

INCLUDE(FindWget)

IF(EXISTS ${PROJECT_SOURCE_DIR}/cmake/version.cmake)

  INCLUDE(${PROJECT_SOURCE_DIR}/cmake/version.cmake)

ELSEIF(DEFINED ENV{LEMON_VERSION})

  SET(LEMON_VERSION $ENV{LEMON_VERSION} CACHE STRING "LEMON version string.")

ELSE()

  EXECUTE_PROCESS(

    COMMAND ${PYTHON_EXECUTABLE} ./scripts/chg-len.py

    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}

    OUTPUT_VARIABLE HG_REVISION_PATH

    ERROR_QUIET

    OUTPUT_STRIP_TRAILING_WHITESPACE

  )

  EXECUTE_PROCESS(

    COMMAND hg id -i

    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}

    OUTPUT_VARIABLE HG_REVISION

    ERROR_QUIET

    OUTPUT_STRIP_TRAILING_WHITESPACE

  )

  IF(HG_REVISION STREQUAL "")

    SET(HG_REVISION_ID "hg-tip")

  ELSE()

    IF(HG_REVISION_PATH STREQUAL "")

      SET(HG_REVISION_ID ${HG_REVISION})

    ELSE()

      SET(HG_REVISION_ID ${HG_REVISION_PATH}.${HG_REVISION})

    ENDIF()

  ENDIF()

  SET(LEMON_VERSION ${HG_REVISION_ID} CACHE STRING "LEMON version string.")

ENDIF()

SET(PROJECT_VERSION ${LEMON_VERSION})

SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

FIND_PACKAGE(Doxygen)

FIND_PACKAGE(Ghostscript)

FIND_PACKAGE(GLPK 4.33)

FIND_PACKAGE(CPLEX)

FIND_PACKAGE(COIN)

IF(DEFINED ENV{LEMON_CXX_WARNING})

  SET(CXX_WARNING $ENV{LEMON_CXX_WARNING})

ELSE()

  IF(CMAKE_COMPILER_IS_GNUCXX)

    SET(CXX_WARNING "-Wall -W -Wunused -Wformat=2 -Wctor-dtor-privacy -Wnon-virtual-dtor -Wno-char-subscripts -Wwrite-strings -Wno-char-subscripts -Wreturn-type -Wcast-qual -Wcast-align -Wsign-promo -Woverloaded-virtual -fno-strict-aliasing -Wold-style-cast -Wno-unknown-pragmas")

    SET(CMAKE_CXX_FLAGS_DEBUG CACHE STRING "-ggdb")

    SET(CMAKE_C_FLAGS_DEBUG CACHE STRING "-ggdb")

  ELSEIF(MSVC)

    # This part is unnecessary 'casue the same is set by the lemon/core.h.

    # Still keep it as an example.

    SET(CXX_WARNING "/wd4250 /wd4355 /wd4503 /wd4800 /wd4996")

    # Suppressed warnings:

    # C4250: 'class1' : inherits 'class2::member' via dominance

    # C4355: 'this' : used in base member initializer list

    # C4503: 'function' : decorated name length exceeded, name was truncated

    # C4800: 'type' : forcing value to bool 'true' or 'false'

    #        (performance warning)

    # C4996: 'function': was declared deprecated

  ELSE()

  ENDIF()

ENDIF()

SET(LEMON_CXX_WARNING_FLAGS ${CXX_WARNING} CACHE STRING "LEMON warning flags.")

SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${LEMON_CXX_WARNING_FLAGS}")

    "Flags used by the C++ compiler during maintainer builds."

    FORCE )

    "Flags used by the C compiler during maintainer builds."

    FORCE )

SET( CMAKE_EXE_LINKER_FLAGS_MAINTAINER

    "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING

    "Flags used for linking binaries during maintainer builds."

    FORCE )

SET( CMAKE_SHARED_LINKER_FLAGS_MAINTAINER

    "-Wl,--warn-unresolved-symbols,--warn-once" CACHE STRING

    "Flags used by the shared libraries linker during maintainer builds."

    FORCE )

MARK_AS_ADVANCED(

    CMAKE_CXX_FLAGS_MAINTAINER

    CMAKE_C_FLAGS_MAINTAINER

    CMAKE_EXE_LINKER_FLAGS_MAINTAINER

    CMAKE_SHARED_LINKER_FLAGS_MAINTAINER )

IF(CMAKE_CONFIGURATION_TYPES)

  LIST(APPEND CMAKE_CONFIGURATION_TYPES Maintainer)

  LIST(REMOVE_DUPLICATES CMAKE_CONFIGURATION_TYPES)

  SET(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING

      "Add the configurations that we need"

      FORCE)

 endif()

IF(NOT CMAKE_BUILD_TYPE)

  SET(CMAKE_BUILD_TYPE "Release")

ENDIF()

SET( CMAKE_BUILD_TYPE "${CMAKE_BUILD_TYPE}" CACHE STRING

    "Choose the type of build, options are: None(CMAKE_CXX_FLAGS or CMAKE_C_FLAGS used) Debug Release RelWithDebInfo MinSizeRel Maintainer."

    FORCE )

INCLUDE(CheckTypeSize)

CHECK_TYPE_SIZE("long long" LONG_LONG)

SET(LEMON_HAVE_LONG_LONG ${HAVE_LONG_LONG})

ENABLE_TESTING()

IF(${CMAKE_BUILD_TYPE} STREQUAL "Maintainer")

  ADD_CUSTOM_TARGET(check ALL COMMAND ${CMAKE_CTEST_COMMAND})

ELSE()

  ADD_CUSTOM_TARGET(check COMMAND ${CMAKE_CTEST_COMMAND})

ENDIF()

ADD_SUBDIRECTORY(lemon)

IF(${CMAKE_SOURCE_DIR} STREQUAL ${PROJECT_SOURCE_DIR})

  ADD_SUBDIRECTORY(demo)

  ADD_SUBDIRECTORY(tools)

  ADD_SUBDIRECTORY(doc)

  ADD_SUBDIRECTORY(test)

ENDIF()

CONFIGURE_FILE(

  ${PROJECT_SOURCE_DIR}/cmake/LEMONConfig.cmake.in

  ${PROJECT_BINARY_DIR}/cmake/LEMONConfig.cmake

  @ONLY

)

IF(UNIX)

  INSTALL(

    FILES ${PROJECT_BINARY_DIR}/cmake/LEMONConfig.cmake

    DESTINATION share/lemon/cmake

  )

ELSEIF(WIN32)

  INSTALL(

    FILES ${PROJECT_BINARY_DIR}/cmake/LEMONConfig.cmake

    DESTINATION cmake

  )

ENDIF()

IF(${CMAKE_SOURCE_DIR} STREQUAL ${PROJECT_SOURCE_DIR})

  SET(CPACK_PACKAGE_NAME ${PROJECT_NAME})

  SET(CPACK_PACKAGE_VENDOR "EGRES")

  SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY

    "LEMON - Library for Efficient Modeling and Optimization in Networks")

  SET(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE")

  SET(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})

  SET(CPACK_PACKAGE_INSTALL_DIRECTORY

    "${PROJECT_NAME} ${PROJECT_VERSION}")

  SET(CPACK_PACKAGE_INSTALL_REGISTRY_KEY

    "${PROJECT_NAME} ${PROJECT_VERSION}")

  SET(CPACK_COMPONENTS_ALL headers library html_documentation bin)

  SET(CPACK_COMPONENT_HEADERS_DISPLAY_NAME "C++ headers")

  SET(CPACK_COMPONENT_LIBRARY_DISPLAY_NAME "Dynamic-link library")

  SET(CPACK_COMPONENT_BIN_DISPLAY_NAME "Command line utilities")

  SET(CPACK_COMPONENT_HTML_DOCUMENTATION_DISPLAY_NAME "HTML documentation")

  SET(CPACK_COMPONENT_HEADERS_DESCRIPTION

    "C++ header files")

  SET(CPACK_COMPONENT_LIBRARY_DESCRIPTION

    "DLL and import library")

  SET(CPACK_COMPONENT_BIN_DESCRIPTION

    "Command line utilities")

  SET(CPACK_COMPONENT_HTML_DOCUMENTATION_DESCRIPTION

    "Doxygen generated documentation")

  SET(CPACK_COMPONENT_HEADERS_DEPENDS library)

  SET(CPACK_COMPONENT_HEADERS_GROUP "Development")

  SET(CPACK_COMPONENT_LIBRARY_GROUP "Development")

  SET(CPACK_COMPONENT_HTML_DOCUMENTATION_GROUP "Documentation")

  SET(CPACK_COMPONENT_GROUP_DEVELOPMENT_DESCRIPTION

    "Components needed to develop software using LEMON")

  SET(CPACK_COMPONENT_GROUP_DOCUMENTATION_DESCRIPTION

    "Documentation of LEMON")

  SET(CPACK_ALL_INSTALL_TYPES Full Developer)

  SET(CPACK_COMPONENT_HEADERS_INSTALL_TYPES Developer Full)

  SET(CPACK_COMPONENT_LIBRARY_INSTALL_TYPES Developer Full)

  SET(CPACK_COMPONENT_HTML_DOCUMENTATION_INSTALL_TYPES Full)

  SET(CPACK_GENERATOR "NSIS")

  SET(CPACK_NSIS_MUI_ICON "${PROJECT_SOURCE_DIR}/cmake/nsis/lemon.ico")

  SET(CPACK_NSIS_MUI_UNIICON "${PROJECT_SOURCE_DIR}/cmake/nsis/uninstall.ico")

  #SET(CPACK_PACKAGE_ICON "${PROJECT_SOURCE_DIR}/cmake/nsis\\\\installer.bmp")

  SET(CPACK_NSIS_INSTALLED_ICON_NAME "bin\\\\lemon.ico")

  SET(CPACK_NSIS_DISPLAY_NAME "${CPACK_PACKAGE_INSTALL_DIRECTORY} ${PROJECT_NAME}")

  SET(CPACK_NSIS_HELP_LINK "http:\\\\\\\\lemon.cs.elte.hu")

  SET(CPACK_NSIS_URL_INFO_ABOUT "http:\\\\\\\\lemon.cs.elte.hu")

  SET(CPACK_NSIS_CONTACT "lemon-user@lemon.cs.elte.hu")

  SET(CPACK_NSIS_CREATE_ICONS_EXTRA "

    CreateShortCut \\\"$SMPROGRAMS\\\\$STARTMENU_FOLDER\\\\Documentation.lnk\\\" \\\"$INSTDIR\\\\share\\\\doc\\\\index.html\\\"

    ")

  SET(CPACK_NSIS_DELETE_ICONS_EXTRA "

    !insertmacro MUI_STARTMENU_GETFOLDER Application $MUI_TEMP

    Delete \\\"$SMPROGRAMS\\\\$MUI_TEMP\\\\Documentation.lnk\\\"

    ")

  INCLUDE(CPack)

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.

    ///This function instantiates a ReachedMap.

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

    ///we would like to define the 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.

    ///This function instantiates a DistMap.

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

    ///the DistMap

    static DistMap *createDistMap(const Digraph &g)

    {

      return new DistMap(g);

    }

    ///The type of the shortest paths.

    ///The type of the shortest paths.

    ///It must meet 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

  /// we have created a wizard class.

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

  protected:

    //The type of the nodes in the digraph.

    typedef typename Base::Digraph::Node Node;

    //Pointer to the digraph the algorithm runs on.

    void *_g;

    //Pointer to the map of reached nodes.

    void *_reached;

    //Pointer to the map of processed nodes.

    void *_processed;

    //Pointer to the map of predecessors arcs.

    void *_pred;

    //Pointer to the map of distances.

    void *_dist;

    //Pointer to the shortest path to the target node.

    void *_path;

    //Pointer to the distance of the target node.

    int *_di;

    public:

    /// Constructor.

    /// This constructor does not require parameters, therefore 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.

    /// This constructor requires one parameter,

    /// others are initiated to \c 0.

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

    BfsWizardBase(const GR &g) :

      _g(reinterpret_cast<void*>(const_cast<GR*>(&g))),

      _reached(0), _processed(0), _pred(0), _dist(0),  _path(0), _di(0) {}

  };

  /// Auxiliary class for the function-type interface of BFS algorithm.

  /// This auxiliary class is created to implement the

  /// \ref bfs() "function-type interface" of \ref Bfs algorithm.

  /// It does not have own \ref run(Node) "run()" method, it uses the

  /// functions and features of the plain \ref Bfs.

  ///

  /// This class should only be used through the \ref bfs() function,

  /// which makes it easier to use the algorithm.

  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.

    BfsWizard() : TR() {}

    /// Constructor that requires parameters.

    /// Constructor that requires parameters.

    /// These parameters will be the default values for the traits class.

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

    BfsWizard(const Digraph &g) :

      TR(g) {}

    ///Copy constructor

    BfsWizard(const TR &b) : TR(b) {}

    ~BfsWizard() {}

    ///Runs BFS algorithm from the given source node.

    ///This method runs BFS algorithm from node \c s

    ///in order to compute the shortest path to each node.

    void run(Node s)

    {

      Bfs<Digraph,TR> alg(*reinterpret_cast<const Digraph*>(Base::_g));

      if (Base::_pred)

        alg.predMap(*reinterpret_cast<PredMap*>(Base::_pred));

      if (Base::_dist)

        alg.distMap(*reinterpret_cast<DistMap*>(Base::_dist));

      if (Base::_reached)

        alg.reachedMap(*reinterpret_cast<ReachedMap*>(Base::_reached));

      if (Base::_processed)

        alg.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));

      if (s!=INVALID)

        alg.run(s);

      else

        alg.run();

    }

    ///Finds the shortest path between \c s and \c t.

    ///This method runs BFS algorithm from node \c s

    ///in order to compute the shortest path to node \c t

    ///(it stops searching when \c t is processed).

    ///

    ///\return \c true if \c t is reachable form \c s.

    bool run(Node s, Node t)

    {

      Bfs<Digraph,TR> alg(*reinterpret_cast<const Digraph*>(Base::_g));

      if (Base::_pred)

        alg.predMap(*reinterpret_cast<PredMap*>(Base::_pred));

      if (Base::_dist)

        alg.distMap(*reinterpret_cast<DistMap*>(Base::_dist));

      if (Base::_reached)

        alg.reachedMap(*reinterpret_cast<ReachedMap*>(Base::_reached));

      if (Base::_processed)

        alg.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));

      alg.run(s,t);

      if (Base::_path)

        *reinterpret_cast<Path*>(Base::_path) = alg.path(t);

      if (Base::_di)

        *Base::_di = alg.dist(t);

      return alg.reached(t);

    }

    ///Runs BFS algorithm to visit all nodes in the digraph.

    ///This method runs BFS algorithm in order to compute

    ///the shortest path to each node.

    void run()

    {

      run(INVALID);

    }

    template<class T>

    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.

    ///

    ///\ref named-func-param "Named parameter"

    ///for setting PredMap object.

    template<class T>

    BfsWizard<SetPredMapBase<T> > predMap(const T &t)

    {

      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));

      return BfsWizard<SetPredMapBase<T> >(*this);

    }

    template<class T>

    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.

    ///

    /// \ref named-func-param "Named parameter"

    ///for setting ReachedMap object.

    template<class T>

    BfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)

    {

      Base::_reached=reinterpret_cast<void*>(const_cast<T*>(&t));

      return BfsWizard<SetReachedMapBase<T> >(*this);

    }

    template<class T>

    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.

    ///

    /// \ref named-func-param "Named parameter"

    ///for setting DistMap object.

    template<class T>

    BfsWizard<SetDistMapBase<T> > distMap(const T &t)

    {

      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));

      return BfsWizard<SetDistMapBase<T> >(*this);

    }

    template<class T>

    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.

    ///

    /// \ref named-func-param "Named parameter"

    ///for setting ProcessedMap object.

    template<class T>

    BfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)

    {

      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));

      return BfsWizard<SetProcessedMapBase<T> >(*this);

    }

    template<class T>

    struct SetPathBase : public Base {

      typedef T Path;

      SetPathBase(const TR &b) : TR(b) {}

    };

    ///\brief \ref named-func-param "Named parameter"

    ///for getting the shortest path to the target node.

    ///

    ///\ref named-func-param "Named parameter"

    ///for getting the shortest path to the target node.

    template<class T>

    BfsWizard<SetPathBase<T> > path(const T &t)

    {

      Base::_path=reinterpret_cast<void*>(const_cast<T*>(&t));

      return BfsWizard<SetPathBase<T> >(*this);

    }

    ///\brief \ref named-func-param "Named parameter"

    ///for getting the distance of the target node.

    ///

    ///\ref named-func-param "Named parameter"

    ///for getting the distance of the target node.

    BfsWizard dist(const int &d)

    {

      Base::_di=const_cast<int*>(&d);

      return *this;

    }

  };

  ///Function-type interface for BFS algorithm.

  /// \ingroup search

  ///Function-type interface for BFS algorithm.

  ///

  ///This function also has several \ref named-func-param "named parameters",

  ///they are declared as the members of class \ref BfsWizard.

  ///The following examples show how to use these parameters.

  ///\code

  ///  // Compute shortest path from node s to each node

  ///  bfs(g).predMap(preds).distMap(dists).run(s);

  ///

  ///  // Compute shortest path from s to t

  ///  bool reached = bfs(g).path(p).dist(d).run(s,t);

  ///\endcode

  ///\warning Don't forget to put the \ref BfsWizard::run(Node) "run()"

  ///to the end of the parameter list.

  ///\sa BfsWizard

  ///\sa Bfs

  template<class GR>

  BfsWizard<BfsWizardBase<GR> >

  bfs(const GR &digraph)

  {

    return BfsWizard<BfsWizardBase<GR> >(digraph);

  }

#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 GR>

  struct BfsVisitor {

    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.

    void start(const Node& node) {}

    /// \brief Called when a node is reached first time.

    ///

    /// This function is called when a node is reached first time.

    void reach(const Node& node) {}

    /// \brief Called when a node is processed.

    ///

    /// This function is called when a node is processed.

    void process(const Node& node) {}

    /// \brief Called when an arc reaches a new node.

    ///

    /// This function is called when the BFS finds an arc whose target node

    /// is not reached yet.

    void discover(const Arc& arc) {}

    /// \brief Called when an arc is examined but its target node is

    /// already discovered.

    ///

    /// This function is called when an arc is examined but its target node is

    /// already discovered.

    void examine(const Arc& arc) {}

  };

#else

  template <typename GR>

  struct BfsVisitor {

    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&) {}

    void discover(const Arc&) {}

    void examine(const Arc&) {}

    template <typename _Visitor>

    struct Constraints {

      void constraints() {

        Arc arc;

        Node node;

        visitor.start(node);

        visitor.reach(node);

        visitor.process(node);

        visitor.discover(arc);

        visitor.examine(arc);

      }

      _Visitor& visitor;

    };

  };

#endif

  /// \brief Default traits class of BfsVisit class.

  ///

  /// Default traits class of BfsVisit class.

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

  template<class GR>

  struct BfsVisitDefaultTraits {

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

    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.

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

    /// \brief Instantiates a ReachedMap.

    ///

    /// This function instantiates a ReachedMap.

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

    /// we would like to define the ReachedMap.

    static ReachedMap *createReachedMap(const Digraph &digraph) {

      return new ReachedMap(digraph);

    }

  };

  /// \ingroup search

  ///

  /// \brief BFS algorithm class with visitor interface.

  ///

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

  /// with visitor interface.

  ///

  /// 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 GR The type of the digraph the algorithm runs on.

  /// The default type is \ref ListDigraph.

  /// The value of GR is not used directly by \ref BfsVisit,

  /// it is only passed to \ref BfsVisitDefaultTraits.

  /// \tparam VS The Visitor type that is used by the algorithm.

  /// \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 TR Traits class to set various data types used by the

  /// algorithm. The default traits class is

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

  /// See \ref BfsVisitDefaultTraits for the documentation of

  /// a BFS visit traits class.

#ifdef DOXYGEN

  template <typename GR, typename VS, typename TR>

#else

  template <typename GR = ListDigraph,

            typename VS = BfsVisitor<GR>,

            typename TR = BfsVisitDefaultTraits<GR> >

#endif

  class BfsVisit {

  public:

    ///The traits class.

    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 VS Visitor;

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

    typedef typename Traits::ReachedMap ReachedMap;

  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 *_digraph;

    //Pointer to the visitor object.

    Visitor *_visitor;

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

    ReachedMap *_reached;

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

    bool local_reached;

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

    int _list_front, _list_back;

    //Creates the maps if necessary.

    void create_maps() {

      if(!_reached) {

        local_reached = true;

        _reached = Traits::createReachedMap(*_digraph);

      }

    }

  protected:

    BfsVisit() {}

  public:

    typedef BfsVisit Create;

    /// \name Named Template Parameters

    ///@{

    template <class T>

    struct SetReachedMapTraits : public Traits {

      typedef T ReachedMap;

      static ReachedMap *createReachedMap(const Digraph &digraph) {

        LEMON_ASSERT(false, "ReachedMap is not initialized");

        return 0; // ignore warnings

      }

    };

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

    /// ReachedMap type.

    ///

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

    template <class T>

    struct SetReachedMap : public BfsVisit< Digraph, Visitor,

                                            SetReachedMapTraits<T> > {

      typedef BfsVisit< Digraph, Visitor, SetReachedMapTraits<T> > Create;

    };

    ///@}

  public:

    /// \brief Constructor.

    ///

    /// Constructor.

    ///

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

    /// \param visitor The visitor object of the algorithm.

    BfsVisit(const Digraph& digraph, Visitor& visitor)

      : _digraph(&digraph), _visitor(&visitor),

        _reached(0), local_reached(false) {}

    /// \brief Destructor.

    ~BfsVisit() {

      if(local_reached) delete _reached;

    }

    /// \brief 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(Node) "run()"

    /// or \ref init(), an instance will be allocated automatically.

    /// The destructor deallocates this automatically allocated map,

    /// of course.

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

    BfsVisit &reachedMap(ReachedMap &m) {

      if(local_reached) {

        delete _reached;

        local_reached = false;

      }

      _reached = &m;

      return *this;

    }

  public:

    /// \name Execution Control

    /// The simplest way to execute the BFS algorithm is to use one of the

    /// member functions called \ref run(Node) "run()".\n

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

    /// \ref init(), then you can add several source nodes with

    /// \ref addSource(). Finally the actual path computation can be

    /// performed with one of the \ref start() functions.

    /// @{

    /// \brief Initializes the internal data structures.

    ///

    /// Initializes the internal data structures.

    void init() {

      create_maps();

      _list.resize(countNodes(*_digraph));

      _list_front = _list_back = -1;

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

        _reached->set(u, false);

      }

    }

    /// \brief 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);

          _visitor->start(s);

          _visitor->reach(s);

          _list[++_list_back] = s;

        }

    }

    /// \brief Processes the next node.

    ///

    /// Processes the next node.

    ///

    /// \return The processed node.

    ///

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

    Node processNextNode() {

      Node n = _list[++_list_front];

      _visitor->process(n);

      Arc e;

      for (_digraph->firstOut(e, n); e != INVALID; _digraph->nextOut(e)) {

        Node m = _digraph->target(e);

        if (!(*_reached)[m]) {

          _visitor->discover(e);

          _visitor->reach(m);

          _reached->set(m, true);

          _list[++_list_back] = m;

        } else {

          _visitor->examine(e);

        }

      }

      return n;

    }

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

    ///

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

    Node processNextNode(Node target, bool& reach) {

      Node n = _list[++_list_front];

      _visitor->process(n);

      Arc e;

      for (_digraph->firstOut(e, n); e != INVALID; _digraph->nextOut(e)) {

        Node m = _digraph->target(e);

        if (!(*_reached)[m]) {

          _visitor->discover(e);

          _visitor->reach(m);

          _reached->set(m, true);

          _list[++_list_back] = m;

          reach = reach || (target == m);

        } else {

          _visitor->examine(e);

        }

      }

      return n;

    }

    /// \brief Processes the next node.

    ///

    /// Processes the next node and checks if at least one of reached

    /// nodes has \c true value in the \c nm node map. If one node

    /// with \c true value is reachable from the processed node, then the

    /// \c rnode parameter will be set to the first of such nodes.

    ///

    /// \param nm A \c bool (or convertible) node map that indicates the

    /// possible targets.

    /// \retval rnode The reached target node.

    /// It should be initially \c INVALID.

    ///

    /// \return The processed node.

    ///

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

    template <typename NM>

    Node processNextNode(const NM& nm, Node& rnode) {

      Node n = _list[++_list_front];

      _visitor->process(n);

      Arc e;

      for (_digraph->firstOut(e, n); e != INVALID; _digraph->nextOut(e)) {

        Node m = _digraph->target(e);

        if (!(*_reached)[m]) {

          _visitor->discover(e);

          _visitor->reach(m);

          _reached->set(m, true);

          _list[++_list_back] = m;

          if (nm[m] && rnode == INVALID) rnode = m;

        } else {

          _visitor->examine(e);

        }

      }

      return n;

    }

    /// \brief The next node to be processed.

    ///

    /// Returns the next node to be processed or \c INVALID if the queue

    /// is empty.

    Node nextNode() const {

      return _list_front != _list_back ? _list[_list_front + 1] : INVALID;

    }

    /// \brief Returns \c false if there are nodes

    /// to be processed.

    ///

    /// Returns \c false if there are nodes

    /// to be processed in the queue.

    bool emptyQueue() const { return _list_front == _list_back; }

    /// \brief Returns the number of the nodes to be processed.

    ///

    /// Returns the number of the nodes to be processed in the queue.

    int queueSize() const { return _list_back - _list_front; }

    /// \brief Executes the algorithm.

    ///

    /// Executes the algorithm.

    ///

    /// This method runs the %BFS algorithm from the root node(s)

    /// in order to compute the shortest path to each node.

    ///

    /// The algorithm computes

    /// - the shortest path tree (forest),

    /// - the distance of each node from the root(s).

    ///

    /// \pre init() must be called and at least one root node should be added

    /// with addSource() before using this function.

    ///

    /// \note <tt>b.start()</tt> is just a shortcut of the following code.

    /// \code

    ///   while ( !b.emptyQueue() ) {

    ///     b.processNextNode();

    ///   }

    /// \endcode

    void start() {

      while ( !emptyQueue() ) processNextNode();

    }

    /// \brief Executes the algorithm until the given target node is reached.

    ///

    /// Executes the algorithm until the given target node is reached.

    ///

    /// This method runs the %BFS algorithm from the root node(s)

    /// in order to compute the shortest path to \c t.

    ///

    /// The algorithm computes

    /// - the shortest path to \c t,

    /// - the distance of \c t from the root(s).

    ///

    /// \pre init() must be called and at least one root node should be

    /// added with addSource() before using this function.

    ///

    /// \note <tt>b.start(t)</tt> is just a shortcut of the following code.

    /// \code

    ///   bool reach = false;

    ///   while ( !b.emptyQueue() && !reach ) {

    ///     b.processNextNode(t, reach);

    ///   }

    /// \endcode

    void start(Node t) {

      bool reach = false;

      while ( !emptyQueue() && !reach ) processNextNode(t, reach);

    }

    /// \brief Executes the algorithm until a condition is met.

    ///

    /// Executes the algorithm until a condition is met.

    ///

    /// This method runs the %BFS algorithm from the root node(s) in

    /// order to compute the shortest path to a node \c v with

    /// <tt>nm[v]</tt> true, if such a node can be found.

    ///

    /// \param nm must be a bool (or convertible) node map. The

    /// algorithm will stop when it reaches a node \c v with

    /// <tt>nm[v]</tt> true.

    ///

    /// \return The reached node \c v with <tt>nm[v]</tt> true or

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

 *

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

 *

 * Copyright (C) 2003-2011

 * 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 graph_concepts

///\file

///\brief The concept of graph components.

#ifndef LEMON_CONCEPTS_GRAPH_COMPONENTS_H

#define LEMON_CONCEPTS_GRAPH_COMPONENTS_H

#include <lemon/core.h>

#include <lemon/concepts/maps.h>

#include <lemon/bits/alteration_notifier.h>

namespace lemon {

  namespace concepts {

    /// \brief Concept class for \c Node, \c Arc and \c Edge types.

    ///

    /// This class describes the concept of \c Node, \c Arc and \c Edge

    /// subtypes of digraph and graph types.

    ///

    /// \note This class is a template class so that we can use it to

    /// create graph skeleton classes. The reason for this is that \c Node

    /// and \c Arc (or \c Edge) types should \e not derive from the same

    /// base class. For \c Node you should instantiate it with character

    /// \c 'n', for \c Arc with \c 'a' and for \c Edge with \c 'e'.

#ifndef DOXYGEN

    template <char sel = '0'>

#endif

    class GraphItem {

    public:

      /// \brief Default constructor.

      ///

      /// Default constructor.

      /// \warning The default constructor is not required to set

      /// the item to some well-defined value. So you should consider it

      /// as uninitialized.

      GraphItem() {}

      /// \brief Copy constructor.

      ///

      /// Copy constructor.

      GraphItem(const GraphItem &) {}

      /// \brief Constructor for conversion from \c INVALID.

      ///

      /// Constructor for conversion from \c INVALID.

      /// It initializes the item to be invalid.

      /// \sa Invalid for more details.

      GraphItem(Invalid) {}

      /// \brief Assignment operator.

      ///

      /// Assignment operator for the item.

      GraphItem& operator=(const GraphItem&) { return *this; }

      /// \brief Assignment operator for INVALID.

      ///

      /// This operator makes the item invalid.

      GraphItem& operator=(Invalid) { return *this; }

      /// \brief Equality operator.

      ///

      /// Equality operator.

      bool operator==(const GraphItem&) const { return false; }

      /// \brief Inequality operator.

      ///

      /// Inequality operator.

      bool operator!=(const GraphItem&) const { return false; }

      /// \brief Ordering operator.

      ///

      /// This operator defines an ordering of the items.

      /// It makes possible to use graph item types as key types in

      /// associative containers (e.g. \c std::map).

      ///

      /// \note This operator only have to define some strict ordering of

      /// the items; this order has nothing to do with the iteration

      /// ordering of the items.

      bool operator<(const GraphItem&) const { return false; }

      template<typename _GraphItem>

      struct Constraints {

        void constraints() {

          _GraphItem i1;

          i1=INVALID;

          _GraphItem i2 = i1;

          _GraphItem i3 = INVALID;

          i1 = i2 = i3;

          bool b;

          b = (ia == ib) && (ia != ib);

          b = (ia == INVALID) && (ib != INVALID);

          b = (ia < ib);

        }

        const _GraphItem &ia;

        const _GraphItem &ib;