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