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 #include <tr1/memory>
  26
  27 class SortAction;
  28 class GeneOrder;
  29
  30 /**
  31  * Sorts genes
  32  *
  33  * \author Michael Andreen
  34  */
  35 class GeneSorter{
  36         public:
  37                 typedef std::tr1::shared_ptr<SortAction> ActionPointer;
  38                 typedef std::vector<ActionPointer> ActionList;
  39
  40                 /**
  41                  * Takes a GeneOrder, finds the actions to transform it into a sorted
  42                  * permutation and returns the list with required actions.
  43                  */
  44                 ActionList sort(const GeneOrder& go1);
  45
  46                 /**
  47                  * Find the safe actions for this GeneOrder.
  48                  */
  49                 ActionList safeActions(const GeneOrder& go1);
  50
  51                 ~GeneSorter(){};
  52 };
  53
  54 #endif
  55