Chromosome.h

Go to the documentation of this file.

//===========================================================================
//===========================================================================



#ifndef __CHROMOSOME_H
#define __CHROMOSOME_H

#ifdef _WIN32
// disable warning C4786: symbol length > 255 character,
// okay to ignore
#pragma warning(disable: 4786)
// disable warning C4804: suspicious bool comparison
// occurs during instantiation of vector< bool >
#pragma warning(disable: 4804)
#endif

#include <string>
#include <vector>
#include <SharkDefs.h>

//
// problems with VC++ 5.0 (can't handle nested scopes)
//
//using namespace std;

//===========================================================================


// forward declarations
class Individual;
class Population;
class IndividualMOO;
class PopulationMOO;


class Chromosome
{
    friend class Individual;
    friend class Population;
    friend class IndividualMOO;
    friend class PopulationMOO;

public:
    bool sameType(const Chromosome& c) const
    {
        return strcmp(typeOfAlleles(), c.typeOfAlleles()) == 0;
    }

    virtual ~Chromosome()
    { }
    virtual const char* typeOfAlleles() const = 0;
    virtual unsigned    size() const = 0;
    virtual Chromosome& operator = (const Chromosome&) = 0;

    virtual unsigned    sizeOfAlleles() const = 0;
    //
    //=======================================================================
    //
    // string operators
    //
    virtual void        resize(unsigned n) = 0;

    virtual void        duplicate(unsigned start,
                                  unsigned stop,
                                  unsigned dest) = 0;
    virtual void        invert(unsigned start,
                               unsigned stop,
                               unsigned granularity = 1) = 0;
    virtual void        transcribe(unsigned start,
                                   unsigned stop,
                                   const Chromosome& chrom) = 0;
    virtual void        swap(unsigned i, unsigned j) = 0;
    virtual void        shuffle() = 0;
    virtual void        replace(unsigned i,
                                const Chromosome& chrom) = 0;
    virtual void        insert(unsigned i,
                               const Chromosome& chrom) = 0;
    virtual void        append(const Chromosome& chrom) = 0;
    virtual void        remove (unsigned i) = 0;
    virtual void        remove (unsigned from, unsigned to) = 0;
    virtual void        rotateRight(unsigned n = 1) = 0;
    virtual void        rotateLeft(unsigned n = 1) = 0;

#ifndef _WIN32
    //
    // Visual C++ 5.0 can't distinguish between different instantiations of
    // template class vector< T >
    virtual void        crossover
    (
        const Chromosome& dad,
        const Chromosome& mom,
        const std::vector< unsigned >& points
    ) = 0;
    virtual void        crossover
    (
        Chromosome& mate,
        const std::vector< unsigned >& points
    ) = 0;
#endif // !_WIN32

    virtual void        crossover
    (
        const Chromosome& dad,
        const Chromosome& mom,
        const std::vector< bool >& pos
    ) = 0;
    virtual void        crossover
    (
        Chromosome& mate,
        const std::vector< bool >& pos
    ) = 0;
    virtual void        crossover
    (
        const Chromosome& dad,
        const Chromosome& mom,
        unsigned npoints,
        unsigned align = 1,
        bool chromswap = 0
    ) = 0;
    virtual void        crossover
    (
        Chromosome& mate,
        unsigned npoints,
        unsigned align = 1,
        bool chromswap = 0

    ) = 0;
    virtual void        crossover
    (
        const Chromosome& dad,
        const Chromosome& mom,
        const Chromosome& pos
    ) = 0;
    virtual void        crossover
    (
        Chromosome& mate,
        const Chromosome& pos
    ) = 0;
    virtual void        crossoverUniform
    (
        const Chromosome& dad,
        const Chromosome& mom,
        const std::vector< bool >& pos
    ) = 0;
    virtual void        crossoverUniform
    (
        Chromosome& mate,
        const std::vector< bool >& pos
    ) = 0;
    virtual void        crossoverUniform
    (
        const Chromosome& dad,
        const Chromosome& mom
    ) = 0;
    virtual void        crossoverUniform
    (
        Chromosome& mate
    ) = 0;
    virtual void        crossoverUniform
    (
        const Chromosome& dad,
        const Chromosome& mom,
        const Chromosome& pos
    ) = 0;
    //  virtual void        crossoverUniform( Chromosome& mate,
    //                    const Chromosome& pos );
    virtual void        recombineDiscrete(const Chromosome& dad,
                                          const Chromosome& mom) = 0;
    virtual void        recombineDiscrete(Chromosome& mate) = 0;
    //

    virtual bool operator < (const Chromosome& c) const;
    virtual bool operator == (const Chromosome& c) const;


    // automatically generated
    //virtual bool operator != ( const Chromosome& c ) const;
    //virtual bool operator >  ( const Chromosome& c ) const;
    //virtual bool operator <= ( const Chromosome& c ) const;
    //virtual bool operator >= ( const Chromosome& c ) const;


    //=======================================================================

    //
    // Added by Marc Toussaint & Stefan Wiegand at 20.11.02
    // (interface methods for more externally from Shark defined Chromosomes)

    typedef unsigned uint;

    virtual void init();

    virtual void init(const char* filename);

    virtual void mutate();

#ifdef EALIB_REGISTER_INDIVIDUAL

    virtual void registerIndividual(const Individual& i, uint you);
#endif

    virtual void appendToIndividual(Individual& i);

    virtual int  pvm_pkchrom();

    virtual int  pvm_upkchrom();


    //=======================================================================

protected:
    virtual Chromosome* clone() const = 0;
    virtual Chromosome* empty() const = 0;

#ifndef __NO_GENERIC_IOSTREAM
    virtual void        writeTo(std::ostream&) const = 0;
    virtual void        readFrom(std::istream&) = 0;

    friend inline std::istream& operator >> (std::istream& is, Chromosome& c)
    {
        c.readFrom(is);
        IO_CHECK(is)
        return is;
    }

    friend inline std::ostream& operator << (std::ostream& os, const Chromosome& c)
    {
        c.writeTo(os);
        IO_CHECK(os)
        return os;
    }
#endif // !__NO_GENERIC_IOSTREAM
};

//===========================================================================

#endif /* !__CHROMOSOME_H */