garp.hh

Go to the documentation of this file.

#ifndef _GARP_HH_
#define _GARP_HH_

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

// required include because of enum PerfIndex and class GarpRule
#include "rules_base.hh" 
#include "bioclim_histogram.hh"
#include "regression.hh"


class GarpRuleSet;

class Random;

/****************************************************************/
/************************* GARP Algorithm ***********************/

class Garp : public AlgorithmImpl
{
public:
  Garp();
  virtual ~Garp();

  int initialize();
  
  int iterate();
  
  int done() const;

  float getProgress() const;

  //
  // Methods used to project the model
  //
  
  Scalar getValue( const Sample& x ) const;
  
  int getConvergence( Scalar * const val ) const;

  int getGeneration() { return _gen; }

  void deleteTempDataMembers();

protected:
  virtual void _getConfiguration( ConfigurationPtr& ) const;
  virtual void _setConfiguration( const ConstConfigurationPtr & );

private:

  void cacheSamples(const SamplerPtr&, OccurrencesPtr&, int resamples);

  void colonize(GarpRuleSet * ruleset, int numRules);

  void evaluate(GarpRuleSet * ruleset);

  void keepFittest(GarpRuleSet * source, GarpRuleSet * target, PerfIndex perfIndex);


  void select(GarpRuleSet * source, GarpRuleSet * target, double gapsize);


  void mutate(GarpRuleSet * ruleset);


  void crossover(GarpRuleSet * ruleset);

  //
  // Algorithm parameters
  //

  int _max_gen;

  int _popsize;

  int _resamples;

  double _acc_limit;

  double _conv_limit;

  double _mortality;

  double _significance; 
  double _crossover_rate;
  double _mutation_rate;
  double _gapsize;

  //
  // Internal variables
  //

  GarpRuleSet * _fittest;

  GarpRuleSet * _offspring;

  BioclimHistogram _bioclimHistogram;

  Regression _regression;

  OccurrencesPtr _cachedOccs;

  double _convergence;
  int _improvements;

  int _curr_heur_count[5];
  int _prev_heur_count[5];

  int _gen;

  mutable float _maxProgress;
};


#endif