src/componenttree.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Michael Andreen                                 *
   3  *   andreen@student.chalmers.se                                           *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA          *
  19  ***************************************************************************/
  20
  21 #ifndef __COMPONENTTREE_H__
  22 #define __COMPONENTTREE_H__
  23
  24 #include <vector>
  25 #include <map>
  26 #include "misc.h"
  27
  28 /**
  29  * Creates and holds a component tree.
  30  */
  31 class ComponentTree {
  32         public:
  33                 /**
  34                  * A node in the component tree.
  35                  */
  36                 struct Node {
  37                         Node(Node* parent, Component comp);
  38                         ~Node();
  39
  40                         Node* _parent;
  41                         Component _comp;
  42                         std::vector<Node*> _children;
  43                 };
  44
  45                 /**
  46                  * Creates a component tree from a list of components.
  47                  */
  48                 ComponentTree(const std::vector<Component>& components);
  49
  50                 ~ComponentTree();
  51
  52                 /**
  53                  * Transforms the tree into the minimal tree containing all unoriented componentes.
  54                  * \todo come up with a better name
  55                  */
  56                 void makeUnoriented();
  57
  58                 /**
  59                  * Count the number of leaves in the component tree.
  60                  * This is the number of hurdles, if makeUnoriented has been called.
  61                  */
  62                 size_t countLeaves();
  63
  64                 /**
  65                  * Number of short branches.
  66                  * If makeUnoriented has been called and countLeaves is >= 3
  67                  * then we have a super hurdle if short branches = 0.
  68                  */
  69                 size_t shortBranches();
  70
  71         private:
  72                 //Disable these, at least for now.
  73                 void operator=(const ComponentTree&){};
  74                 ComponentTree(const ComponentTree&): _root(0){};
  75
  76                 void removeOriented(Node* n);
  77                 size_t countLeaves(Node* n);
  78                 void branches (Node* n, std::map<Node*,size_t> & b);
  79
  80                 Node* _root;
  81
  82         friend class ComponentTreeTest;
  83 };
  84
  85 #endif