Graph.h

Go to the documentation of this file.

//
// File: Graph.h
// Authors:
//   Thomas Bigot
// Last modified: vendredi 4 novembre 2016, à 10h 21
//
 
/*
  Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
  
  This software is a computer program whose purpose is to provide utilitary
  classes. This file belongs to the Bio++ Project.
  
  This software is governed by the CeCILL license under French law and
  abiding by the rules of distribution of free software. You can use,
  modify and/ or redistribute the software under the terms of the CeCILL
  license as circulated by CEA, CNRS and INRIA at the following URL
  "http://www.cecill.info".
  
  As a counterpart to the access to the source code and rights to copy,
  modify and redistribute granted by the license, users are provided only
  with a limited warranty and the software's author, the holder of the
  economic rights, and the successive licensors have only limited
  liability.
  
  In this respect, the user's attention is drawn to the risks associated
  with loading, using, modifying and/or developing or reproducing the
  software by the user in light of its specific status of free software,
  that may mean that it is complicated to manipulate, and that also
  therefore means that it is reserved for developers and experienced
  professionals having in-depth computer knowledge. Users are therefore
  encouraged to load and test the software's suitability as regards their
  requirements in conditions enabling the security of their systems and/or
  data to be ensured and, more generally, to use and operate it in the
  same conditions as regards security.
  
  The fact that you are presently reading this means that you have had
  knowledge of the CeCILL license and that you accept its terms.
*/
 
#ifndef BPP_GRAPH_GRAPH_H
#define BPP_GRAPH_GRAPH_H
 
#include <algorithm>
#include <iostream>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <utility>
#include <vector>
 
 
// forward declaration to avoid circular dependancies.
// since we do not need its size in this header file (only using pointers to it)
namespace bpp
{
class GraphObserver;
}
 
namespace bpp
{
class Graph
{
public:
  typedef unsigned int NodeId;
  typedef unsigned int EdgeId;
 
 
  virtual ~Graph(){}
 
protected:
  virtual void setRoot(NodeId newRoot) = 0;
 
public:
  virtual NodeId getRoot() const = 0;
 
  virtual void makeDirected() = 0;
 
  virtual void makeUndirected() = 0;
 
  // /@}
 
 
  // /@{
 
  virtual NodeId createNode() = 0;
 
  virtual NodeId createNodeFromNode(NodeId origin) = 0;
 
  virtual NodeId createNodeOnEdge(NodeId edge) = 0;
 
 
  virtual NodeId createNodeFromEdge(NodeId origin) = 0;
 
protected:
  virtual EdgeId link(NodeId nodeA, NodeId nodeB) = 0;
 
  virtual void link(Graph::NodeId nodeA, Graph::NodeId nodeB, Graph::EdgeId edgeID) = 0;
 
  virtual std::vector<EdgeId> unlink(NodeId nodeA, NodeId nodeB) = 0;
 
public:
  virtual void deleteNode(NodeId node) = 0;
 
  // /@}
 
  // /@{
 
  virtual void registerObserver(GraphObserver* observer) = 0;
 
  virtual void unregisterObserver(GraphObserver* observer) = 0;
 
// /@}
 
  // /@{
 
  class NodeIterator
  {
public:
    virtual ~NodeIterator() {}
 
    virtual void next() = 0;
    virtual bool end() const = 0;
    virtual void start() = 0;
 
    virtual NodeId operator*() = 0;
  };
 
  struct ALLGRAPHITER {};
  struct OUTGOINGNEIGHBORITER {};
  struct INCOMINGNEIGHBORITER {};
 
  /*
   * @brief builds iterator on all Nodes of the graph
   *
   */
 
  virtual std::unique_ptr<NodeIterator> allNodesIterator() = 0;
 
  virtual std::unique_ptr<NodeIterator> allNodesIterator() const = 0;
 
  /*
   * @brief builds iterator on the outgoing neighbor nodes of a Node
   *
   */
 
  virtual std::unique_ptr<NodeIterator> outgoingNeighborNodesIterator(NodeId node) = 0;
 
  /*
   * @brief builds iterator on the incoming neighbor nodes of a Node
   *
   */
 
  virtual std::unique_ptr<NodeIterator> incomingNeighborNodesIterator(NodeId node) = 0;
 
 
  virtual size_t getNumberOfNodes() const = 0;
 
  virtual size_t getNumberOfEdges() const = 0;
 
  virtual size_t getDegree(NodeId node) const = 0;
 
  virtual bool isLeaf(NodeId node) const = 0;
 
  virtual size_t getNumberOfNeighbors(NodeId node) const = 0;
 
  virtual size_t getNumberOfOutgoingNeighbors(NodeId node) const = 0;
 
  virtual size_t getNumberOfIncomingNeighbors(const NodeId node) const = 0;
 
  virtual std::vector<NodeId> getNeighbors(const NodeId node) const = 0;
 
  virtual std::vector<NodeId> getOutgoingNeighbors(const NodeId node) const = 0;
 
  virtual std::vector<NodeId> getIncomingNeighbors(NodeId node) const = 0;
 
  virtual std::vector<NodeId> getLeavesFromNode(NodeId node, unsigned int maxDepth) const = 0;
 
  virtual std::vector<NodeId> getAllLeaves() const = 0;
 
  virtual std::set<NodeId> getSetOfAllLeaves() const = 0;
 
  virtual std::vector<NodeId> getAllInnerNodes() const = 0;
 
  virtual std::vector<NodeId> getAllNodes() const = 0;
 
  virtual std::pair<NodeId, NodeId> getNodes(EdgeId edge) const = 0;
 
  virtual NodeId getTop(EdgeId edge) const = 0;
 
  virtual NodeId getBottom(EdgeId edge) const = 0;
 
  // /@}
 
  // /@{
 
  virtual bool isTree() const = 0;
 
  virtual bool isDA() const = 0;
 
 
  virtual void orientate() = 0;
 
  virtual bool isDirected() const = 0;
 
 
  virtual bool containsReciprocalRelations() const = 0;
 
 
  // /@}
 
 
  // /@{
 
  class EdgeIterator
  {
public:
    virtual ~EdgeIterator() {}
 
    virtual void next() = 0;
    virtual bool end() const = 0;
    virtual void start() = 0;
 
    virtual EdgeId operator*() = 0;
  };
 
 
  /*
   * @brief builds iterator on all Nodes of the graph
   *
   */
 
  virtual std::unique_ptr<EdgeIterator> allEdgesIterator() = 0;
 
  /*
   * @brief builds iterator on the outgoing neighbor nodes of a Node
   *
   */
 
  virtual std::unique_ptr<EdgeIterator> outgoingEdgesIterator(NodeId node) = 0;
 
  /*
   * @brief builds iterator on the incoming neighbor nodes of a Node
   *
   */
 
  virtual std::unique_ptr<EdgeIterator> incomingEdgesIterator(NodeId node) = 0;
 
  virtual std::vector<EdgeId> getEdges(const NodeId node) const = 0;
 
  virtual std::vector<EdgeId> getOutgoingEdges(const NodeId node) const = 0;
 
  virtual std::vector<EdgeId> getIncomingEdges(NodeId node) const = 0;
 
  virtual std::vector<EdgeId> getAllEdges() const = 0;
 
  virtual EdgeId getEdge(NodeId nodeA, NodeId nodeB) const = 0;
 
  virtual EdgeId getAnyEdge(NodeId nodeA, NodeId nodeB) const = 0;
 
  // /@}
 
protected:
  // /@{
 
  virtual void notifyDeletedEdges(const std::vector<EdgeId>& edgesToDelete) const = 0;
 
  virtual void notifyDeletedNodes(const std::vector<NodeId>& nodesToDelete) const = 0;
 
 
  // /@}
 
public:
  virtual void outputToDot(std::ostream& out, const std::string& name) const = 0;
 
  template<class N, class E, class GraphImpl>
  friend class AssociationGraphImplObserver;
};
}
#endif // BPP_GRAPH_GRAPH_H