ga/include/core/genotype.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 GENOTYPE_H
#define GENOTYPE_H

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

namespace farsa {

class FARSA_GA_API Genotype : public ParameterSettableWithConfigureFunction {
public:
    Genotype( unsigned int size = 0 );
    virtual ~Genotype();
    Genotype( QString, bool compressed=false );
    Genotype( const Genotype& genotype );
    virtual Genotype& operator=( const Genotype& genotype );
    void assign( const Genotype* genotype );
    virtual Genotype* clone() const;
    unsigned int size() const;
    void setFitness( double value );
    double fitness() const;
    void setObjective( int i, double value );
    double objective( int i ) const;
    int numOfObjectives() const;
    bool dominatedBy( const Genotype* genotype );
    void setRank( double rank );
    double rank() const;
    bool bit( unsigned int i ) const;
    void set( unsigned int i );
    void unset( unsigned int i );
    void toggle( unsigned int i );
    QString notes() const;
    void setNotes( QString notes );
    int hammingDistance( const Genotype* );
    virtual void randomize();
    QString toString() const;
    void fromString( QString );
    QString toCompressedString() const;
    bool fromCompressedString( QString str );
    unsigned int extractUInt( unsigned int startPos, unsigned int stopPos );
    void insertUInt( unsigned int value, unsigned int startPos, unsigned int stopPos );

    virtual unsigned int geneToBitIndex( unsigned int gene ) const;
    virtual unsigned int bitToGeneIndex( unsigned int bit ) const;

    virtual void configure( ConfigurationParameters& params, QString prefix );
    virtual void save( ConfigurationParameters& params, QString prefix );
    static void describe( QString type );
    
    static bool rankGreaterThanComparator( const Genotype *g1, const Genotype *g2 ) {
        return (g1->rank() > g2->rank());
    };
    class nObjectiveGreaterThanComparator {
    public:
        bool operator()( const Genotype* g1, const Genotype* g2 ) {
            return g1->objective( objectiveToCompare ) > g2->objective( objectiveToCompare );
        };
        int objectiveToCompare; 
    };

protected:
    unsigned char* data;
    unsigned int sizev;
    unsigned int allocated;
    QVector<double> fitnessv;
    double rankv;
    QString notesv;
    void copyDataFrom( Genotype* source );

    void resize( unsigned int newsize );
};

} // end namespace farsa

#endif