ga/include/core/mutation.h

/********************************************************************************
 *  FARSA Genetic Algorithm Library                                             *
 *  Copyright (C) 2007-2008 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 MUTATION_H
#define MUTATION_H

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

namespace farsa {

class Genotype;
class Genome;
class GeneticAlgo;

class FARSA_GA_API Mutation : public ParameterSettableWithConfigureFunction {
public:
    Mutation();

    virtual ~Mutation();

    virtual void mutate( Genotype* ) = 0;

    void setMutationRate( double rate, int start = 0, int length = -1);

    void setMutationRate( double initialRate, double finalRate, double variation, int start = 0, int length = -1);

    double mutationRate( int bit );

    double initialMutationRate( int bit );

    double finalMutationRate( int bit );

    double variationMutationRate( int bit );
    
    void setGenome( const Genome* g ) {
        genomev = g;
    }

    const Genome* genome() {
        return genomev;
    }

    void setGA( GeneticAlgo* g ) {
        ga = g;
    }

    GeneticAlgo* GA() {
        return ga;
    }

    virtual void configure( ConfigurationParameters& params, QString prefix );

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

protected:
    const Genome* genomev;

    GeneticAlgo* ga;

private:
    // Here we have all mutation rates stuffs, to force even child classes
    // to use functions, which will keep everything in a consistent state

    void updateMutationRates();

    struct MutationRate {
        MutationRate() :
            initial(0.0),
            final(0.0),
            variation(0.0),
            mutaRate(0.0)
        {
        }

        void rateForGeneration(unsigned int gen);

        double initial;

        double final;

        double variation;

        double mutaRate;
    };

    const MutationRate& getMutationRateForBit( int bit ) const;

    QMap<int, MutationRate> mutaRates;

    QMutex mutaRatesMutex;

    unsigned int lastGenMutaRatesChange;
};

} // end namespace farsa

#endif