geneticalgorithm.h

Go to the documentation of this file.

/*
    
  This file is a part of MOGAL, a Multi-Objective Genetic Algorithm
  Library.
  
  Copyright (C) 2008-2012 Jori Liesenborgs

  Contact: jori.liesenborgs@gmail.com

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  
  USA

*/

#ifndef MOGAL_GENETICALGORITHM_H

#define MOGAL_GENETICALGORITHM_H

#include "mogalconfig.h"
#include "genome.h"
#include <serut/serializationinterface.h>
#include <enut/networklayeraddress.h>
#include <stdlib.h>
#include <vector>
#include <list>

namespace mogal
{

class GAFactory;
class GAFactoryParams;
class GAModule;
class Genome;

class MOGAL_IMPORTEXPORT GeneticAlgorithmParams : public errut::ErrorBase
{
public:
        GeneticAlgorithmParams();

        GeneticAlgorithmParams(double beta, bool elitism, bool includeBest, double crossoverRate);
        ~GeneticAlgorithmParams();

        double getBeta() const                                                                  { return m_beta; }

        bool useElitism() const                                                                 { return m_elitism; }

        bool alwaysIncludeBestGenome() const                                                    { return m_alwaysIncludeBest; }

        double getCrossOverRate() const                                                         { return m_crossoverRate; }

        bool write(serut::SerializationInterface &si);
        bool read(serut::SerializationInterface &si);
private:
        double m_beta, m_crossoverRate;
        bool m_elitism, m_alwaysIncludeBest;
};
        
class MOGAL_IMPORTEXPORT GeneticAlgorithm : public errut::ErrorBase
{
public:
        GeneticAlgorithm();
        ~GeneticAlgorithm();

        bool run(GAFactory &factory, size_t populationSize, const GeneticAlgorithmParams *pParams = 0);

        bool run(const std::string &factoryName, size_t populationSize, 
                 const std::string &baseDir, const GAFactoryParams *pFactoryParams, 
                 const GeneticAlgorithmParams *pParams = 0);

        bool run(const nut::NetworkLayerAddress &serverAddress, uint16_t serverPort, 
                 const std::string &factoryName, size_t populationSize, 
                 GAFactory &factory, const GeneticAlgorithmParams *pParams = 0);

        bool run(const nut::NetworkLayerAddress &serverAddress, uint16_t serverPort, const std::string &factoryName, 
                 size_t populationSize, const std::string &baseDir, const GAFactoryParams *pFactoryParams, 
                 const GeneticAlgorithmParams *pParams = 0);

        void getBestGenomes(std::list<Genome *> &genomes) const;

        void getBestGenomes(std::vector<Genome *> &genomes) const;

        size_t getNumberOfBestGenomes() const                                                   { return m_bestGenomes.size(); }

        void setBestGenomes(const std::list<Genome *> &genomes);

        Genome *selectPreferredGenome() const;
        
        void clearBestGenomes();

        int getCurrentGeneration() const                                                        { return m_generationCount; }
protected:
        virtual bool calculateFitness(std::vector<GenomeWrapper> &population);
        virtual bool onAlgorithmLoop(GAFactory &factory, bool generationInfoChanged);
        virtual void onCurrentBest(const std::list<Genome *> &bestGenomes) const                { }
        virtual void feedbackStatus(const std::string &str) const                               { }
        virtual bool stopRemoteAlgorithm()                                                      { return false; }
private:
        bool processNewBestGenomes(GAFactory &factory, serut::SerializationInterface &si);
        
        std::list<Genome *> m_bestGenomes;
        GAModule *m_pGAModule;
        GAFactory *m_pLoadedFactory;
        GAFactory *m_pCurrentFactory;
        int m_generationCount;
};
        
} // end namespace

#endif // MOGAL_GENETICALGORITHM_H