geneticalgo.h

/********************************************************************************
 *  FARSA Genetic Algorithm Library                                             *
 *  Copyright (C) 2007-2009 Gianluca Massera <emmegian@yahoo.it>                *
 *                                                                              *
 *  This program is free software; you can redistribute it and/or modify        *
 *  it under the terms of the GNU General Public License as published by        *
 *  the Free Software Foundation; either version 2 of the License, or           *
 *  (at your option) any later version.                                         *
 *                                                                              *
 *  This program is distributed in the hope that it will be useful,             *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of              *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               *
 *  GNU General Public License for more details.                                *
 *                                                                              *
 *  You should have received a copy of the GNU General Public License           *
 *  along with this program; if not, write to the Free Software                 *
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA  *
 ********************************************************************************/

#ifndef GENETICALGO_H
#define GENETICALGO_H

#include "gaconfig.h"
#include "parametersettable.h"
#include <QVector>

namespace farsa {

class Genotype;
class Genome;
class Evaluation;
class GeneticAlgo;

class FARSA_GA_API GeneticAlgoIODelegate {
public:
    virtual void saveData( GeneticAlgo* /*ga*/ ) { }
    virtual void recoverData( GeneticAlgo* /*ga*/ ) { };
};

class FARSA_GA_API GeneticAlgoObserver {
public:
    virtual ~GeneticAlgoObserver() { };
    virtual void onEndGeneration() { };
};

class FARSA_GA_API GeneticAlgo : public ParameterSettableWithConfigureFunction {
public:
    GeneticAlgo( );
    virtual ~GeneticAlgo();
    ParameterSettableUI* getUIManager();
    void addObserver( GeneticAlgoObserver* observer );
    void removeObserver( GeneticAlgoObserver* observer );
    virtual void initialize() = 0;
    virtual void gaStep() = 0;
    virtual void finalize() = 0;
    void evolve( unsigned int generationToReach );
    void evolve();
    bool isEvolutionEnded();
    bool isEvaluationDone();
    void setGenome( Genome* gen );
    Genome* genome();
    const Genome* genome() const;
    virtual Evaluation* evaluationPrototype() = 0;
    virtual QVector<Evaluation*> evaluationPool() = 0;
    void setGeneration( unsigned int gen );
    unsigned int generation() const;
    void setNumGenerations( int g );
    int numGenerations();
    virtual void skipEvaluation() = 0;
    QVector< QVector<double> > bestFits() const;
    QVector< QVector<double> > averageFits() const;
    QVector<double> meanHammingDist() const;
    QVector<double> varianceHammingDist() const;
    QVector<double> standardDeviationHammingDist() const;
    void setIODelegate( GeneticAlgoIODelegate* iodelegate );
    GeneticAlgoIODelegate* getIODelegate() const;

protected:
    void updateStats();

    bool evolutionEnd;

    bool evaluationDone;
    
    void notifyEndGeneration();

    Genome* genomev;
    unsigned int generationv;
    unsigned int numGens;

    QVector< QVector<double> > bestfits;
    QVector< QVector<double> > avgfits;
    QVector<double> meanHdists;
    QVector<double> varHdists;
    QVector<double> stdHdists;
    
    GeneticAlgoIODelegate* iodelegate;
    QList<GeneticAlgoObserver*> observers;
};

} // end namespace farsa

#endif