src/genesorter.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 __GENESORTER_H__
  22 #define __GENESORTER_H__
  23
  24 #include <vector>
  25
  26 class SortAction;
  27 class GeneOrder;
  28 class Model;
  29
  30 /**
  31  * Sorts genes
  32  *
  33  * \author Michael Andreen
  34  */
  35 class GeneSorter{
  36         public:
  37                 typedef std::vector<SortAction> ActionList;
  38
  39                 /**
  40                  * Takes a GeneOrder, finds the actions to transform it into a sorted
  41                  * permutation and returns the list with required actions.
  42                  */
  43                 ActionList sort(const GeneOrder& go1, const Model& m);
  44
  45                 /**
  46                  * Find the safe actions for this GeneOrder.
  47                  */
  48                 ActionList safeActions(const GeneOrder& go1);
  49
  50                 /**
  51                  * Calculates the score for an action given a gene order
  52                  */
  53                 size_t scoreAction(const GeneOrder& go, SortAction& sa);
  54
  55                 ~GeneSorter(){};
  56 };
  57
  58 #endif
  59