ga/include/gas/laralga.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 FARSAGA_H
#define FARSAGA_H

#include "gaconfig.h"
#include "core/geneticalgo.h"
#include <QList>

namespace farsa {

class MultiTrials;
class Mutation;

class FARSA_GA_API LaralGA : public GeneticAlgo {
public:
    LaralGA();
    virtual ~LaralGA();
    void setNumThreads( int numThreads );
    int numThreads();
    void setFitnessFunction( MultiTrials* fitfunc );
    virtual Evaluation* evaluationPrototype();
    virtual QVector<Evaluation*> evaluationPool();
    MultiTrials* fitnessFunction();
    void setMutation( Mutation* mutate );
    Mutation* mutation();
    void setReproduceParams( int nreproducing, bool useElitism = false, int nelitism = 0 );
    int numReproducing();
    int numOffspring();
    int numElitism();
    bool isElitismEnabled();
    virtual void initialize();
    virtual void gaStep();
    virtual void finalize();

    virtual void skipEvaluation();

    virtual void configure( ConfigurationParameters& params, QString prefix );
    virtual void save( ConfigurationParameters& params, QString prefix );
    static void describe( QString type );

protected:
    MultiTrials* fitfunc;
    Mutation* muta;
    unsigned int currGenotype;
    int nreproducing;
    int noffspring;
    int nelitism;
    bool elitismEnabled;
    typedef enum { initEvaluation, evaluating, nextGeneration_pass1, nextGeneration_pass2, endEvolution } GAPhases;
    GAPhases currPhase;
    bool isInitialized;
    bool isFinalized;

private:
    void createNextGeneration();
    bool nextGeneration;

    class evaluationThread {
    public:
        //--- Constructor
        evaluationThread( LaralGA* p, MultiTrials* eProto );
        //--- Destructor
        ~evaluationThread();
        //--- LaralGA parent
        LaralGA* parent;
        //--- evaluator used by this object
        MultiTrials* eval;
        //--- evaluating genoma
        int id;
        //--- true when it cannot increment id because the end is reached
        bool blocked;
        //--- run a step of evaluation
        void runStep();
        //--- sequence of Genoma to evaluate
        QVector<int> sequence;
        //--- actual id inside sequence in evaluating
        int idSeq;
    };

    QList<evaluationThread*> evalThreads;
    int numThreadv;
    static void runStepWrapper( LaralGA::evaluationThread* e );
};

} // end namespace farsa

#endif