AssociationTreeGraphObserver.h

Go to the documentation of this file.

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

#ifndef BPP_GRAPH_ASSOCIATIONTREEGRAPHOBSERVER_H
#define BPP_GRAPH_ASSOCIATIONTREEGRAPHOBSERVER_H

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

#include "AssociationGraphObserver.h"
#include "TreeGraph.h"

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

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

public:
  virtual bool isValid() const = 0;

  virtual std::shared_ptr<E>  getEdgeToFather(const std::shared_ptr<N>  nodeObject) const = 0;

  virtual std::shared_ptr<E>  getEdgeToFather(const NodeIndex nodeIndex) const = 0;

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

  /*
   * @brief check if rooted, ie directed
   *
   */

  virtual bool isRooted() const = 0;

  virtual std::shared_ptr<N>  getFatherOfNode(const std::shared_ptr<N>  nodeObject) 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::vector<std::shared_ptr<E>> getBranches(const std::shared_ptr<N>  node) const = 0;

  virtual std::vector<EdgeIndex> getBranches(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 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 setFather(const std::shared_ptr<N>  nodeObject, const std::shared_ptr<N>  fatherNodeObject, const std::shared_ptr<E> edgeObject = 0) = 0;

  virtual void addSon(const std::shared_ptr<N>  nodeObject, const std::shared_ptr<N>  sonNodeObject, 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 branches to sons of a Node
   *
   */

  virtual std::unique_ptr<EdgeIterator> branchesIterator(std::shared_ptr<N> node) = 0;

  virtual std::unique_ptr<EdgeIterator> branchesIterator(std::shared_ptr<N> node) const = 0;

  virtual std::vector<std::shared_ptr<N>> getNodePathBetweenTwoNodes(const std::shared_ptr<N>  nodeA, const std::shared_ptr<N>  nodeB, bool includeAncestor = true) const = 0;

  virtual std::vector<std::shared_ptr<E>> getEdgePathBetweenTwoNodes(const std::shared_ptr<N>  nodeA, const std::shared_ptr<N>  nodeB) const = 0;

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

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