FTMTreeUtils.cpp

Go to the documentation of this file.

#include <FTMTree.h>
#include <FTMTreeUtils.h>
#include <iostream>
 
void ttk::ftm::printTreesStats(std::vector<FTMTree_MT *> &trees) {
  for(auto tree : trees)
    tree->printTreeStats();
}
 
namespace ttk {
  namespace ftm {
 
    // --------------------
    // Is
    // --------------------
    bool FTMTree_MT::isNodeOriginDefined(idNode nodeId) const {
      unsigned int const origin
        = (unsigned int)this->getNode(nodeId)->getOrigin();
      return origin != nullNodes && origin < this->getNumberOfNodes();
    }
 
    bool FTMTree_MT::isRoot(idNode nodeId) const {
      return this->getNode(nodeId)->getNumberOfUpSuperArcs() == 0;
    }
 
    bool FTMTree_MT::isLeaf(idNode nodeId) const {
      return this->getNode(nodeId)->getNumberOfDownSuperArcs() == 0;
    }
 
    bool FTMTree_MT::isNodeAlone(idNode nodeId) const {
      return this->isRoot(nodeId) and this->isLeaf(nodeId);
    }
 
    bool FTMTree_MT::isFullMerge() const {
      idNode const treeRoot = this->getRoot();
      return (unsigned int)this->getNode(treeRoot)->getOrigin() == treeRoot;
    }
 
    bool FTMTree_MT::isBranchOrigin(idNode nodeId) const {
      return this->getParentSafe(this->getNode(nodeId)->getOrigin()) != nodeId;
    }
 
    bool FTMTree_MT::isNodeMerged(idNode nodeId) const {
      bool merged = this->isNodeAlone(nodeId)
                    or this->isNodeAlone(this->getNode(nodeId)->getOrigin());
      auto nodeIdOrigin = this->getNode(nodeId)->getOrigin();
      merged
        = merged or nodeIdOrigin == this->getNode(nodeIdOrigin)->getOrigin();
      return merged;
    }
 
    bool FTMTree_MT::isNodeIdInconsistent(idNode nodeId) const {
      return nodeId >= this->getNumberOfNodes();
    }
 
    bool FTMTree_MT::isThereOnlyOnePersistencePair() const {
      idNode const treeRoot = this->getRoot();
      unsigned int cptNodeAlone = 0;
      idNode otherNode = treeRoot;
      for(unsigned int i = 0; i < this->getNumberOfNodes(); ++i)
        if(this->isNodeAlone(i))
          cptNodeAlone++;
        else if(i != treeRoot)
          otherNode = i;
      // unsigned int origin = (unsigned
      // int)tree->getNode(otherNode)->getOrigin();
      idNode const treeRootOrigin = this->getNode(treeRoot)->getOrigin();
      return (otherNode != treeRoot
              and this->getNumberOfNodes() - cptNodeAlone == 2
              and (treeRootOrigin == otherNode or treeRootOrigin == treeRoot));
      /*return (otherNode != treeRoot and cptNodeAlone ==
        tree->getNumberOfNodes()-2 and (origin == treeRoot or otherNode ==
        origin));*/
    }
 
    // Do not normalize node is if root or son of a merged root
    bool FTMTree_MT::notNeedToNormalize(idNode nodeId) const {
      auto nodeIdParent = this->getParentSafe(nodeId);
      return this->isRoot(nodeId)
             or (this->isRoot(nodeIdParent)
                 and nodeIdParent
                       == (unsigned int)this->getNode(nodeIdParent)
                            ->getOrigin());
      // and nodeIdOrigin == nodeIdParent) )
    }
 
    bool FTMTree_MT::isMultiPersPair(idNode nodeId) const {
      auto nodeOriginOrigin
        = (unsigned int)this->getNode(this->getNode(nodeId)->getOrigin())
            ->getOrigin();
      return nodeOriginOrigin != nodeId;
    }
 
    // --------------------
    // Get
    // --------------------
    idNode FTMTree_MT::getRoot() const {
      for(idNode node = 0; node < this->getNumberOfNodes(); ++node)
        if(this->isRoot(node) and !this->isLeaf(node))
          return node;
      return nullNodes;
    }
 
    idNode FTMTree_MT::getParentSafe(idNode nodeId) const {
      if(!this->isRoot(nodeId)) {
        // _ Nodes in merge trees should have only one parent
        idSuperArc const arcId = this->getNode(nodeId)->getUpSuperArcId(0);
        idNode const parentNodeId = this->getSuperArc(arcId)->getUpNodeId();
        return parentNodeId;
      }
      return nodeId;
    }
 
    void FTMTree_MT::getChildren(idNode nodeId,
                                 std::vector<idNode> &childrens) const {
      childrens.clear();
      for(idSuperArc i = 0;
          i < this->getNode(nodeId)->getNumberOfDownSuperArcs(); ++i) {
        idSuperArc const arcId = this->getNode(nodeId)->getDownSuperArcId(i);
        childrens.push_back(this->getSuperArc(arcId)->getDownNodeId());
      }
    }
 
    void FTMTree_MT::getLeavesFromTree(std::vector<idNode> &treeLeaves) const {
      treeLeaves.clear();
      for(idNode i = 0; i < this->getNumberOfNodes(); ++i) {
        if(this->isLeaf(i) and !this->isRoot(i))
          treeLeaves.push_back(i);
      }
    }
 
    int FTMTree_MT::getNumberOfLeavesFromTree() const {
      std::vector<idNode> leaves;
      this->getLeavesFromTree(leaves);
      return leaves.size();
    }
 
    int FTMTree_MT::getNumberOfNodeAlone() const {
      int cpt = 0;
      for(idNode i = 0; i < this->getNumberOfNodes(); ++i)
        cpt += this->isNodeAlone(i) ? 1 : 0;
      return cpt;
    }
 
    int FTMTree_MT::getRealNumberOfNodes() const {
      return this->getNumberOfNodes() - this->getNumberOfNodeAlone();
    }
 
    void FTMTree_MT::getBranchOriginsFromThisBranch(
      idNode node,
      std::tuple<std::vector<idNode>, std::vector<idNode>> &res) const {
      std::vector<idNode> branchOrigins, nonBranchOrigins;
 
      idNode const nodeOrigin = this->getNode(node)->getOrigin();
      idNode nodeParent = this->getParentSafe(nodeOrigin);
      while(nodeParent != node) {
        if(this->isBranchOrigin(nodeParent))
          branchOrigins.push_back(nodeParent);
        else
          nonBranchOrigins.push_back(nodeParent);
        nodeParent = this->getParentSafe(nodeParent);
      }
 
      res = std::make_tuple(branchOrigins, nonBranchOrigins);
    }
 
    void FTMTree_MT::getTreeBranching(
      std::vector<idNode> &branching,
      std::vector<int> &branchingID,
      std::vector<std::vector<idNode>> &nodeBranching) const {
      branching = std::vector<idNode>(this->getNumberOfNodes());
      branchingID = std::vector<int>(this->getNumberOfNodes(), -1);
      nodeBranching
        = std::vector<std::vector<idNode>>(this->getNumberOfNodes());
      int branchID = 0;
      std::queue<idNode> queue;
      queue.emplace(this->getRoot());
      while(!queue.empty()) {
        idNode const node = queue.front();
        queue.pop();
        if(this->isLeaf(node))
          continue;
        auto nodeOrigin = this->getNode(node)->getOrigin();
        idNode parentNodeOrigin = nodeOrigin;
        while(parentNodeOrigin != node) {
          branching[parentNodeOrigin] = node;
          branchingID[parentNodeOrigin] = branchID;
          nodeBranching[node].push_back(parentNodeOrigin);
          parentNodeOrigin = this->getParentSafe(parentNodeOrigin);
        }
        if(this->isRoot(node)) {
          branching[node] = node;
          branchingID[node] = branchID;
        }
        ++branchID;
        std::vector<idNode> children;
        this->getChildren(node, children);
        for(idNode const child : children)
          queue.emplace(child);
      }
    }
 
    void FTMTree_MT::getTreeBranching(std::vector<idNode> &branching,
                                      std::vector<int> &branchingID) const {
      std::vector<std::vector<idNode>> nodeBranching;
      this->getTreeBranching(branching, branchingID, nodeBranching);
    }
 
    void FTMTree_MT::getAllRoots(std::vector<idNode> &roots) const {
      roots.clear();
      for(idNode node = 0; node < this->getNumberOfNodes(); ++node)
        if(this->isRoot(node) and !this->isLeaf(node))
          roots.push_back(node);
    }
 
    int FTMTree_MT::getNumberOfRoot() const {
      int noRoot = 0;
      for(idNode node = 0; node < this->getNumberOfNodes(); ++node)
        if(this->isRoot(node) and !this->isLeaf(node))
          ++noRoot;
      return noRoot;
    }
 
    int FTMTree_MT::getNumberOfChildren(idNode nodeId) const {
      return this->getNode(nodeId)->getNumberOfDownSuperArcs();
    }
 
    int FTMTree_MT::getTreeDepth() const {
      int maxDepth = 0;
      std::queue<std::tuple<idNode, int>> queue;
      queue.emplace(this->getRoot(), 0);
      while(!queue.empty()) {
        auto tup = queue.front();
        queue.pop();
        idNode const node = std::get<0>(tup);
        int const depth = std::get<1>(tup);
        maxDepth = std::max(maxDepth, depth);
        std::vector<idNode> children;
        this->getChildren(node, children);
        for(idNode const child : children)
          queue.emplace(child, depth + 1);
      }
      return maxDepth;
    }
 
    int FTMTree_MT::getNodeLevel(idNode nodeId) const {
      int level = 0;
      auto root = this->getRoot();
      int const noRoot = this->getNumberOfRoot();
      if(noRoot != 1) {
        std::stringstream ss;
        ss << "problem, there is " << noRoot << " root(s)";
        printErr(ss.str());
        this->printTree();
      }
      if(this->isNodeAlone(nodeId))
        return 0;
      while(nodeId != root) {
        nodeId = this->getParentSafe(nodeId);
        ++level;
      }
      return level;
    }
 
    void FTMTree_MT::getAllNodeLevel(std::vector<int> &allNodeLevel) const {
      allNodeLevel = std::vector<int>(this->getNumberOfNodes());
      std::queue<std::tuple<idNode, int>> queue;
      queue.emplace(this->getRoot(), 0);
      while(!queue.empty()) {
        auto tup = queue.front();
        queue.pop();
        idNode const node = std::get<0>(tup);
        int const level = std::get<1>(tup);
        allNodeLevel[node] = level;
        std::vector<idNode> children;
        this->getChildren(node, children);
        for(idNode const child : children)
          queue.emplace(child, level + 1);
      }
    }
 
    void FTMTree_MT::getLevelToNode(
      std::vector<std::vector<idNode>> &levelToNode) const {
      std::vector<int> allNodeLevel;
      this->getAllNodeLevel(allNodeLevel);
      int const maxLevel
        = *max_element(allNodeLevel.begin(), allNodeLevel.end());
      levelToNode = std::vector<std::vector<idNode>>(maxLevel + 1);
      for(unsigned int i = 0; i < allNodeLevel.size(); ++i) {
        levelToNode[allNodeLevel[i]].push_back(i);
      }
    }
 
    void
      FTMTree_MT::getBranchSubtree(std::vector<idNode> &branching,
                                   idNode branchRoot,
                                   std::vector<idNode> &branchSubtree) const {
      branchSubtree.clear();
      std::queue<idNode> queue;
      queue.push(branchRoot);
      while(!queue.empty()) {
        idNode const node = queue.front();
        queue.pop();
 
        if(branching[node] != branchRoot
           and this->getParentSafe(node) == branchRoot and node != branchRoot)
          continue;
 
        branchSubtree.push_back(node);
        std::vector<idNode> children;
        this->getChildren(node, children);
        for(idNode const child : children)
          queue.push(child);
      }
    }
 
    // --------------------
    // Persistence
    // --------------------
    void FTMTree_MT::getMultiPersOriginsVectorFromTree(
      std::vector<std::vector<idNode>> &treeMultiPers) const {
      treeMultiPers
        = std::vector<std::vector<idNode>>(this->getNumberOfNodes());
      for(unsigned int i = 0; i < this->getNumberOfNodes(); ++i)
        if(this->isLeaf(i) and this->isNodeOriginDefined(i)
           and not this->isNodeAlone(i)
           and this->getNode(this->getNode(i)->getOrigin())->getOrigin()
                 != (int)i)
          treeMultiPers[this->getNode(i)->getOrigin()].push_back(i);
    }
 
    // --------------------
    // Set
    // --------------------
    void FTMTree_MT::setParent(idNode nodeId, idNode newParentNodeId) {
      this->deleteParent(nodeId);
      this->makeSuperArc(nodeId, newParentNodeId);
    }
 
    // --------------------
    // Delete
    // --------------------
    // Delete node by keeping subtree
    void FTMTree_MT::deleteNode(idNode nodeId) {
      if(this->isRoot(nodeId) and !this->isLeaf(nodeId))
        printErr("deletion of root!");
 
      idNode const parentNodeId = this->getParentSafe(nodeId);
      if(!this->isRoot(nodeId)) {
        // Delete down arc from parent node
        // _ Nodes in trees should have only one parent
        idSuperArc const nodeArcId = this->getNode(nodeId)->getUpSuperArcId(0);
        this->getNode(parentNodeId)->removeDownSuperArc(nodeArcId);
      }
      // Delete up arc from child nodes
      for(idSuperArc i = 0;
          i < this->getNode(nodeId)->getNumberOfDownSuperArcs(); ++i) {
        idSuperArc const arcId = this->getNode(nodeId)->getDownSuperArcId(i);
        idNode const childNodeId = this->getSuperArc(arcId)->getDownNodeId();
        this->getNode(childNodeId)->removeUpSuperArc(arcId);
        if(!this->isRoot(nodeId))
          this->makeSuperArc(childNodeId, parentNodeId);
      }
      // Reset deleted node
      this->getNode(nodeId)->clearDownSuperArcs();
      this->getNode(nodeId)->clearUpSuperArcs();
    }
 
    void FTMTree_MT::deleteIthUpArc(idNode nodeId, int arcIth) {
      idSuperArc const nodeArcId
        = this->getNode(nodeId)->getUpSuperArcId(arcIth);
      // Delete down arc from old parent
      idNode const parentNodeId = this->getSuperArc(nodeArcId)->getUpNodeId();
      this->getNode(parentNodeId)->removeDownSuperArc(nodeArcId);
      // Delete up arc from node
      this->getNode(nodeId)->removeUpSuperArc(nodeArcId);
    }
 
    void FTMTree_MT::deleteParent(idNode nodeId) {
      if(!this->isRoot(nodeId)) {
        // _ Nodes in trees should have only one parent
        this->deleteIthUpArc(nodeId, 0);
      }
    }
 
    void FTMTree_MT::deleteSubtree(idNode nodeId) {
      std::queue<idNode> queue;
      queue.push(nodeId);
      while(!queue.empty()) {
        idNode const node = queue.front();
        queue.pop();
        std::vector<idNode> children;
        this->getChildren(node, children);
        for(idNode const child : children)
          queue.push(child);
        this->deleteNode(node);
      }
    }
 
    // --------------------
    // Create/Delete/Modify Tree
    // --------------------
    void FTMTree_MT::copyMergeTreeStructure(const FTMTree_MT *tree) {
      // Add Nodes
      for(unsigned int i = 0; i < tree->getNumberOfNodes(); ++i)
        this->makeNode(i);
      for(unsigned int i = 0; i < tree->getNumberOfNodes(); ++i)
        this->getNode(i)->setOrigin(tree->getNode(i)->getOrigin());
 
      // Add Arcs
      for(unsigned int i = 0; i < tree->getNumberOfNodes(); ++i) {
        for(unsigned int j = 0;
            j < tree->getNode(i)->getNumberOfDownSuperArcs(); ++j) {
          auto superArcId = tree->getNode(i)->getDownSuperArcId(j);
          this->makeSuperArc(tree->getSuperArc(superArcId)->getDownNodeId(), i);
        }
      }
    }
 
    // --------------------
    // Utils
    // --------------------
    void FTMTree_MT::printNodeSS(idNode node, std::stringstream &ss) const {
      ss << "(" << node << ") \\ ";
 
      std::vector<idNode> children;
      this->getChildren(node, children);
      for(idNode const child : children)
        ss << "+" << child << " ";
 
      if(!this->isRoot(node))
        ss << " / +" << this->getParentSafe(node);
      ss << std::endl;
    }
 
    std::stringstream FTMTree_MT::printSubTree(idNode subRoot) const {
      std::stringstream ss;
      ss << "Nodes----------" << std::endl;
      std::queue<idNode> queue;
      queue.push(subRoot);
      while(!queue.empty()) {
        idNode node = queue.front();
        queue.pop();
 
        printNodeSS(node, ss);
 
        std::vector<idNode> children;
        this->getChildren(node, children);
        for(idNode child : children)
          queue.push(child);
      }
      return ss;
    }
 
    std::stringstream FTMTree_MT::printTree(bool doPrint) const {
      std::stringstream ss;
      std::vector<idNode> allRoots;
      this->getAllRoots(allRoots);
      if(allRoots.size() != 1)
        ss << allRoots.size() << " roots" << std::endl;
      for(unsigned int i = 0; i < allRoots.size(); ++i) {
        if(allRoots.size() != 1)
          ss << i << " _ ";
        ss << this->printSubTree(allRoots[i]).str();
      }
      if(allRoots.size() == 0)
        for(unsigned int i = 0; i < this->getNumberOfNodes(); ++i)
          // if(not tree->isNodeAlone(i))
          printNodeSS(i, ss);
 
      if(doPrint)
        printMsg(ss.str());
      return ss;
    }
 
    std::stringstream FTMTree_MT::printTreeStats(bool doPrint) const {
      auto noNodesT = this->getNumberOfNodes();
      auto noNodes = this->getRealNumberOfNodes();
      std::stringstream ss;
      ss << "tree [node: " << noNodes << " / " << noNodesT;
      ss << ", depth: " << this->getTreeDepth() << "]";
      if(doPrint)
        printMsg(ss.str());
      return ss;
    }
 
    std::stringstream
      FTMTree_MT::printMultiPersOriginsVectorFromTree(bool doPrint) const {
      std::stringstream ss;
      std::vector<std::vector<idNode>> vec;
      this->getMultiPersOriginsVectorFromTree(vec);
      for(unsigned int i = 0; i < vec.size(); ++i)
        if(vec[i].size() != 0) {
          ss << i << " : ";
          for(auto t : vec[i])
            ss << t << " ";
          ss << std::endl;
        }
 
      if(doPrint)
        printMsg(ss.str());
      return ss;
    }
 
    // --------------------
    // Make tree utils
    // --------------------
    void manageInconsistentArcsMultiParent(FTMTree_MT *tree) {
      ftm::idNode treeRoot = 0;
      for(unsigned int i = 0; i < tree->getNumberOfNodes(); ++i) {
        if(tree->getNode(i)->getNumberOfDownSuperArcs() != 0
           and tree->getNode(i)->getNumberOfUpSuperArcs() == 0)
          treeRoot = i;
      }
 
      for(unsigned int i = 0; i < tree->getNumberOfNodes(); ++i)
        if(tree->getNode(i)->getNumberOfUpSuperArcs() > 1) {
          ftm::idNode lowestParent = std::numeric_limits<ftm::idNode>::max();
          for(long unsigned int j = 0;
              j < tree->getNode(i)->getNumberOfUpSuperArcs(); ++j) {
            auto tParent
              = tree->getSuperArc(tree->getNode(i)->getUpSuperArcId(j))
                  ->getUpNodeId();
            lowestParent = (lowestParent > tParent) ? tParent : lowestParent;
          }
 
          for(long unsigned int j = 0;
              j < tree->getNode(i)->getNumberOfUpSuperArcs(); ++j) {
            ftm::idSuperArc const nodeArcId
              = tree->getNode(i)->getUpSuperArcId(j);
            auto tParent = tree->getSuperArc(nodeArcId)->getUpNodeId();
            if(tParent != lowestParent) {
 
              if(tParent == treeRoot) {
                for(long unsigned int k = 0;
                    k < tree->getNode(i)->getNumberOfDownSuperArcs(); ++k) {
                  ftm::idSuperArc const nodeArcId2
                    = tree->getNode(i)->getDownSuperArcId(k);
                  auto tChildren
                    = tree->getSuperArc(nodeArcId2)->getDownNodeId();
                  if(tChildren > i) {
                    tree->getNode(i)->removeDownSuperArc(nodeArcId2);
                    tree->getNode(tChildren)->removeUpSuperArc(nodeArcId2);
                    tree->makeSuperArc(tChildren, treeRoot);
                    break;
                  }
                }
              }
 
              // Delete down arc from old parent
              tree->getNode(tParent)->removeDownSuperArc(nodeArcId);
              // Delete up arc from node
              tree->getNode(i)->removeUpSuperArc(nodeArcId);
            }
          }
        }
    }
 
    void removeSelfLink(FTMTree_MT *tree) {
      for(unsigned int i = 0; i < tree->getNumberOfNodes(); ++i) {
        for(unsigned int j = 0; j < tree->getNode(i)->getNumberOfUpSuperArcs();
            ++j) {
          ftm::idSuperArc const nodeArcId
            = tree->getNode(i)->getUpSuperArcId(j);
          auto tParent = tree->getSuperArc(nodeArcId)->getUpNodeId();
          if(tParent == i) {
            // Delete down arc
            tree->getNode(i)->removeDownSuperArc(nodeArcId);
            // Delete up arc
            tree->getNode(i)->removeUpSuperArc(nodeArcId);
          }
        }
      }
    }
 
  } // namespace ftm
} // namespace ttk