genome.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_GENOME_H

#define MOGAL_GENOME_H

#include "mogalconfig.h"
#include <string>

namespace mogal
{

class MOGAL_IMPORTEXPORT Genome
{
public:
        Genome()                                                                                        { }
        virtual ~Genome()                                                                               { }

        virtual bool calculateFitness() = 0;

        virtual void setActiveFitnessComponent(int componentNumber)                                     { }

        virtual bool isFitterThan(const Genome *pGenome) const = 0;

        virtual Genome *reproduce(const Genome *pGenome) const = 0;
        
        // NOTE: Clone should also copy fitness info etc, since it is also used to store the
        //       current best genome

        virtual Genome *clone() const = 0;
        
        virtual void mutate() = 0;

        virtual std::string getFitnessDescription() const = 0;

        // TODO
        virtual void copyFitnessValuesTo(float *pDestination, int amount) const                         { }
};

class GenomeWrapper
{
public:
        GenomeWrapper(Genome *pGenome = 0, int parent1 = -1, int parent2 = -1, int position = -1)       { m_pGenome = pGenome; m_parent1 = parent1; m_parent2 = parent2; m_position = position; }

        ~GenomeWrapper()                                                                                { }

        Genome *getGenome() const                                                                       { return m_pGenome; }

        int getParent1() const                                                                          { return m_parent1; }

        int getParent2() const                                                                          { return m_parent2; }

        int getPosition() const                                                                         { return m_position; }
private:
        Genome *m_pGenome;
        int m_parent1;
        int m_parent2;
        int m_position;
};

inline bool operator< (const GenomeWrapper &g1, const GenomeWrapper &g2)
{
        return g1.getGenome()->isFitterThan(g2.getGenome());
}

} // end namespace

#endif // MOGAL_GENOME_H