src/model.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 __MODEL_H__
  22 #define __MODEL_H__
  23
  24 #include <tr1/memory>
  25 #include <string>
  26
  27 class SortAction;
  28 class GeneOrder;
  29
  30 namespace Models {
  31         class ModelImpl;
  32 }
  33
  34 /**
  35  * Abstraction of a model.
  36  *
  37  * Handles scoring of specific actions on gene orders.
  38  */
  39 class Model{
  40         public:
  41                 typedef std::tr1::shared_ptr<Models::ModelImpl> ModelPointer;
  42
  43                 /**
  44                  * Constructs a new model.
  45                  *
  46                  * \param model The actual model implementation. This model takes
  47                  *      ownership of the new allocated implementation and will delete it.
  48                  */
  49                 Model(Models::ModelImpl* model);
  50
  51                 /**
  52                  * Gives the score for the action on a given gene order.
  53                  * A better match for this model gives a higher score.
  54                  */
  55                 double score(const SortAction& sa, const GeneOrder& go) const;
  56
  57                 /**
  58                  * The name for the model used.
  59                  */
  60                 const char* name() const;
  61
  62                 /**
  63                  * Creates a model from a name.
  64                  */
  65                 static Model modelFactory(const std::string& name);
  66
  67         private:
  68                 ModelPointer _impl;
  69
  70 };
  71
  72 bool operator<(const Model& lh,const Model& rh);
  73
  74 #endif