TreeGraph.h

Go to the documentation of this file.

//
// File: TreeGraph.h
// Authors:
//   Thomas Bigot
// Last modified: vendredi 4 novembre 2016, à 10h 25
//
 
/*
  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_TREEGRAPH_H
#define BPP_GRAPH_TREEGRAPH_H
 
#include <iostream>
#include <ostream>
#include <string>
#include <vector>
 
#include "../Exceptions.h"
#include "../Numeric/VectorTools.h"
#include "Graph.h"
 
namespace bpp
{
class TreeGraph :
  public virtual Graph
{
public:
  virtual bool isValid() const = 0;
 
  virtual Graph::NodeId getFatherOfNode(Graph::NodeId nodeid) const = 0;
 
  virtual Graph::EdgeId getEdgeToFather(Graph::NodeId node) const = 0;
 
  virtual bool hasFather(Graph::NodeId node) const = 0;
 
  virtual bool isLeaf(Graph::NodeId node) const = 0;
 
  virtual std::vector<Graph::NodeId> getLeavesUnderNode(Graph::NodeId node) const = 0;
 
  virtual std::vector<Graph::NodeId> getSons(Graph::NodeId node) const = 0;
 
  virtual std::vector<Graph::EdgeId> getBranches(Graph::NodeId node) const = 0;
 
  virtual std::unique_ptr<Graph::NodeIterator> sonsIterator(Graph::NodeId node) = 0;
 
  virtual std::unique_ptr<Graph::NodeIterator> sonsIterator(Graph::NodeId node) const = 0;
 
  virtual std::unique_ptr<Graph::EdgeIterator> branchesIterator(Graph::NodeId node) = 0;
 
  virtual std::unique_ptr<Graph::EdgeIterator> branchesIterator(Graph::NodeId node) const = 0;
 
  virtual size_t getNumberOfSons(Graph::NodeId node) const = 0;
 
  virtual void setFather(Graph::NodeId node, Graph::NodeId fatherNode) = 0;
 
  virtual void setFather(Graph::NodeId node, Graph::NodeId fatherNode, Graph::EdgeId edgeId) = 0;
 
  virtual void addSon(Graph::NodeId node, Graph::NodeId sonNode) = 0;
 
  virtual void addSon(Graph::NodeId node, Graph::NodeId sonNode, Graph::EdgeId edgeId) = 0;
 
  std::vector<Graph::NodeId> removeSons(Graph::NodeId node);
 
  virtual void removeSon(Graph::NodeId node, Graph::NodeId son) = 0;
 
  virtual void rootAt(Graph::NodeId newRoot) = 0;
 
  virtual void unRoot(bool joinRootSons) = 0;
 
  virtual void setOutGroup(Graph::NodeId newOutGroup) = 0;
 
  virtual std::vector<Graph::NodeId> getSubtreeNodes(Graph::NodeId localRoot) const = 0;
 
  virtual std::vector<Graph::EdgeId> getSubtreeEdges(Graph::NodeId localRoot) const = 0;
 
  // ///FROM TREETOOLS & TREETOOLS COMPAT
 
 
  virtual std::vector<Graph::NodeId> getNodePathBetweenTwoNodes(Graph::NodeId nodeA, Graph::NodeId nodeB, bool includeAncestor = true) const = 0;
 
  virtual std::vector<Graph::EdgeId> getEdgePathBetweenTwoNodes(Graph::NodeId nodeA, Graph::NodeId nodeB) const = 0;
 
  /*
   * @bref Compute the MRCA of the gven nodes
   *
   */
 
  virtual Graph::NodeId MRCA(const std::vector<Graph::NodeId>& nodes) const = 0;
};
}
#endif // BPP_GRAPH_TREEGRAPH_H