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
  26 class SortAction;
  27 class GeneOrder;
  28
  29 namespace Models {
  30         class ModelImpl;
  31 }
  32
  33 /**
  34  * Abstraction of a model.
  35  *
  36  * Handles scoring of specific actions on gene orders.
  37  */
  38 class Model{
  39         public:
  40                 typedef std::tr1::shared_ptr<Models::ModelImpl> ModelPointer;
  41
  42                 /**
  43                  * Constructs a new model.
  44                  *
  45                  * \param model The actual model implementation. This model takes
  46                  *      ownership of the new allocated implementation and will delete it.
  47                  */
  48                 Model(Models::ModelImpl* model);
  49
  50                 /**
  51                  */
  52                 double score(const SortAction& sa, const GeneOrder& go) const;
  53
  54                 const char* name() const;
  55
  56         private:
  57                 ModelPointer _impl;
  58
  59 };
  60
  61 bool operator<(const Model& lh,const Model& rh);
  62
  63 #endif