ga/include/core/genome.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 GENOME_H
#define GENOME_H

#include "gaconfig.h"
#include "parametersettable.h"
#include "core/genotype.h"
#include <QVector>

namespace farsa {

class FARSA_GA_API Genome : public ParameterSettableWithConfigureFunction {
public:
    Genome();
    Genome( unsigned int numGenotype, unsigned int numBits );
    Genome( unsigned int numGenotype, const Genotype* prototype );
    Genome( const Genome& genome );
    ~Genome();
    Genome& operator=( const Genome& right );
    virtual void configure( ConfigurationParameters& params, QString prefix );
    virtual void save( ConfigurationParameters& params, QString prefix );
    static void describe( QString type );

    unsigned int size() const;
    void clearAll();
    void append( const Genotype* );
    Genotype* at( unsigned int i );
    const Genotype* at( unsigned int i ) const;
    Genotype* last();
    const Genotype* last() const;
    unsigned int find( const Genotype* g );
    void set( unsigned int i, Genotype* g );
    const Genotype* operator[]( unsigned int i ) const;
    Genotype* operator[]( unsigned int i );
    Genotype* prototypeGenotype() {
        return prototype;
    };
    void randomize();
    QVector<Genotype*>::iterator begin() {
        return data.begin();
    };
    QVector<Genotype*>::const_iterator begin() const {
        return data.begin();
    };
    QVector<Genotype*>::iterator end() {
        return data.end();
    };
    QVector<Genotype*>::const_iterator end() const {
        return data.end();
    };

private:
    QVector<Genotype*> data;
    Genotype* prototype;
};

} // end namespace farsa

#endif