rules_base.hh

Go to the documentation of this file.

#ifndef _RULES_BASE_HH_
#define _RULES_BASE_HH_

#include <openmodeller/om.hh>
#include <openmodeller/Sample.hh>

enum PerfIndex
{
  PerfUtil = 0,

  PerfPrStr = 1,

  PerfPrProb = 2,

  PerfPrDist = 3,

  PerfPostStr = 4,

  PerfPostProb = 5,

  PerfPostDist = 6,

  PerfCov = 7,

  PerfSig = 8,

  PerfErr = 9

};


enum RuleOrigin
{
  OriginColonization = 0,
  OriginMutation = 1,
  OriginJoin = 2,
  OriginCrossover = 3
};


enum RuleType
{
  VirtualRuleType = -1,
  RangeRuleType = 0,
  NegatedRuleType = 1,
  LogitRuleType = 2,
  AtomicRuleType = 3
};

bool equalEps(double v1, double v2);
bool between(double value, double min, double max);
int membership(double value1, double value2, double value);


/****************************************************************/
/****************** GarpRule class hierarchy ********************/

class GarpRule  
{
public:
  GarpRule();

  GarpRule(const int numGenes);

  GarpRule(Scalar prediction, int numGenes, 
     const Sample& chrom1, const Sample& chrom2, 
     const double * performances);
  
  virtual ~GarpRule();


  virtual GarpRule * clone() const;

  virtual GarpRule * objFactory() const = 0;
  
  virtual int copy(const GarpRule * fromRule);

  int numGenes() const { return _numGenes; }

  virtual char type() const       { return 'v'; }
  bool needsEvaluation() const    { return _needsEvaluation; } 
  void forceEvaluation() { _needsEvaluation = true; } 
  void evaluated()       { _needsEvaluation = false; } 
  void setPrediction(double pred) { _prediction = pred; }

  Scalar getPrediction() const    { return _prediction; }
  const Sample& getChrom1() const { return _chrom1; };
  const Sample& getChrom2() const { return _chrom2; };
  const double * getPerformanceArray() const { return static_cast<const double *>(_performance); }
  double getPerformance(PerfIndex perfIndex) const;

  virtual int getStrength(const Sample& sample) const = 0;
  virtual int getCertainty(const Scalar pred) const;
  virtual double getError(const Scalar predefinedValue, const Scalar prediction) const;
  
  virtual bool similar(const GarpRule * compareToRule) const;
  virtual void mutate(double temperature);
  virtual void crossover(GarpRule * rule, int xpt1, int xpt2);

  void adjustRange(Scalar& v1, Scalar& v2) const;
  virtual bool applies(const Sample& sample) const = 0;
  double evaluate(const OccurrencesPtr& occs);
  
  virtual void log();

protected:
  Sample _chrom1;
  Sample _chrom2;
  Scalar _prediction;
  
  int _numGenes;
  
  double _performance[10];
  bool _needsEvaluation;
  char _origin;
};

// ====================================================================

#endif