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 #include <string>
  28 #include <stdexcept>
  29
  30 struct fann;
  31
  32 /**
  33  * Identifies the model this gene order belongs to
  34  * \author Michael Andreen
  35  */
  36 class ModelIdentifier{
  37         public:
  38                 //TODO: Make a Model class with functions for scoring SortActions
  39                 //one subclass for each model. Possibly storing name as string too.
  40                 enum Model{Whirl,X,FatX,Zipper,Cloud};
  41
  42                 /**
  43                  * Creates a new identifier given an artificial neural network
  44                  *
  45                  * \param ann filename, including path, to the neural network
  46                  *
  47                  * \throws std::invalid_argument exception if the ann could not be
  48                  * opened
  49                  */
  50                 ModelIdentifier(std::string ann);
  51
  52                 /**
  53                  * Identifies the model for a given gene order.
  54                  *
  55                  * \returns a map with the model as key and the score between -1 and 1
  56                  */
  57                 std::map<Model,double> identify(const GeneOrder& go);
  58
  59                 static std::string modelName(Model m);
  60
  61                 ~ModelIdentifier();
  62         private:
  63                 fann* _ann;
  64
  65                 //disable for the moment
  66                 void operator=(const ModelIdentifier&){}
  67
  68 };
  69
  70 #endif
  71