src/ModelIdentifier.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 __MODELIDENTIFIER_H__
  22 #define __MODELIDENTIFIER_H__
  23
  24 #include "GeneOrder.h"
  25
  26 #include <map>
  27
  28
  29 /**
  30  * Identifies the model this gene order belongs to
  31  * \author Michael Andreen
  32  */
  33 class ModelIdentifier{
  34         public:
  35                 enum Model{Whirl,X,FatX,Zipper,Cloud};
  36
  37                 /**
  38                  * Identifies the model for a given gene order.
  39                  * \returns a map with the model as key and the score between 0 and 1
  40                  */
  41                 std::map<Model,double> identify(const GeneOrder& go);
  42
  43                 virtual ~ModelIdentifier(){};
  44 };
  45
  46 #endif
  47