AssociationDAGraphObserver.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_GRAPH_ASSOCIATIONDAGRAPHOBSERVER_H
#define BPP_GRAPH_ASSOCIATIONDAGRAPHOBSERVER_H

#include <iostream>
#include <map>
#include <memory>
#include <ostream>
#include <vector>

#include "AssociationGraphObserver.h"
#include "DAGraph.h"

namespace bpp
{
template<class N, class E>
class AssociationDAGraphObserver :
  public virtual AssociationGraphObserver<N, E>
{
public:
  typedef typename AssociationDAGraphObserver<N, E>::NodeIndex NodeIndex;
  typedef typename AssociationDAGraphObserver<N, E>::EdgeIndex EdgeIndex;

  typedef typename DAGraph::NodeId NodeGraphid;
  typedef typename DAGraph::EdgeId EdgeGraphid;

public:
  virtual bool isValid() const = 0;

  virtual bool isRooted() const = 0;

  virtual void rootAt(const std::shared_ptr<N> root) = 0;


  virtual std::vector<std::shared_ptr<N>> getFathers(const std::shared_ptr<N>  node) const = 0;

  virtual std::vector<NodeIndex> getFathers(const NodeIndex node) const = 0;

  virtual bool hasFather(const std::shared_ptr<N>  nodeObject) const = 0;
  virtual bool hasFather(const NodeIndex node) const = 0;

  virtual std::vector<std::shared_ptr<N>> getSons(const std::shared_ptr<N>  node) const = 0;

  virtual std::vector<NodeIndex> getSons(const NodeIndex node) const = 0;

  virtual std::shared_ptr<N> getSon(const std::shared_ptr<E>  edge) const = 0;
  virtual NodeIndex getSon(const EdgeIndex edge) const = 0;

  virtual std::shared_ptr<N> getFatherOfEdge(const std::shared_ptr<E>  edge) const = 0;
  virtual NodeIndex getFatherOfEdge(const EdgeIndex edge) const = 0;

  virtual size_t getNumberOfSons(const std::shared_ptr<N>  node) const = 0;

  virtual size_t getNumberOfFathers(const std::shared_ptr<N>  node) const = 0;

  virtual std::vector<std::shared_ptr<N>> getLeavesUnderNode(std::shared_ptr<N>  node) const = 0;

  virtual std::vector<std::shared_ptr<N>> removeSons(const std::shared_ptr<N>  node) = 0;

  virtual void removeSon(const std::shared_ptr<N> node, const std::shared_ptr<N> son) = 0;

  virtual void addSon(const std::shared_ptr<N>  nodeObject, const std::shared_ptr<N>  sonNodeObject, const std::shared_ptr<E> edgeObject = 0) = 0;

  virtual std::vector<std::shared_ptr<N>> removeFathers(const std::shared_ptr<N> node) = 0;

  virtual void removeFather(const std::shared_ptr<N> node, const std::shared_ptr<N> father) = 0;

  virtual void addFather(const std::shared_ptr<N>  nodeObject, const std::shared_ptr<N>  fatherNodeObject, const std::shared_ptr<E> edgeObject = 0) = 0;

  /*
   * @brief builds iterator on the neighbor nodes of a Node
   *
   */

  typedef typename AssociationGraphObserver<N, E>::NodeIterator NodeIterator;
  typedef typename AssociationGraphObserver<N, E>::EdgeIterator EdgeIterator;


  /*
   * @brief builds iterator on the sons of a Node
   *
   */

  virtual std::unique_ptr<NodeIterator> sonsIterator(std::shared_ptr<N> node) = 0;

  virtual std::unique_ptr<NodeIterator> sonsIterator(std::shared_ptr<N> node) const = 0;

  /*
   * @brief builds iterator on the fathers of a Node
   *
   */

  virtual std::unique_ptr<NodeIterator> fathersIterator(std::shared_ptr<N> node) = 0;

  virtual std::unique_ptr<NodeIterator> fathersIterator(std::shared_ptr<N> node) const = 0;

  virtual std::vector<std::shared_ptr<N>> getBelowNodes(const std::shared_ptr<N> localRoot) = 0;

  virtual std::vector<std::shared_ptr<E>> getBelowEdges(const std::shared_ptr<N> localRoot) = 0;
};
}
#endif // BPP_GRAPH_ASSOCIATIONDAGRAPHOBSERVER_H