MOEO.h

// -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*-

//-----------------------------------------------------------------------------
// MOEO.h
// (c) OPAC Team (LIFL), Dolphin Project (INRIA), 2007
/*
    This library...

    Contact: paradiseo-help@lists.gforge.inria.fr, http://paradiseo.gforge.inria.fr
 */
//-----------------------------------------------------------------------------

#ifndef MOEO_H_
#define MOEO_H_

#include <iostream>
#include <stdexcept>
#include <string>
#include <EO.h>

template < class MOEOObjectiveVector, class MOEOFitness, class MOEODiversity >
class MOEO : public EO < MOEOObjectiveVector >
{
public:

    typedef MOEOObjectiveVector ObjectiveVector;

    typedef MOEOFitness Fitness;

    typedef MOEODiversity Diversity;


    MOEO()
    {
        // default values for every parameters
        objectiveVectorValue = ObjectiveVector();
        fitnessValue = Fitness();
        diversityValue = Diversity();
        // invalidate all
        invalidate();
    }


    virtual ~MOEO() {};


    ObjectiveVector objectiveVector() const
    {
        if ( invalidObjectiveVector() )
        {
            throw std::runtime_error("invalid objective vector in MOEO");
        }
        return objectiveVectorValue;
    }


    void objectiveVector(const ObjectiveVector & _objectiveVectorValue)
    {
        objectiveVectorValue = _objectiveVectorValue;
        invalidObjectiveVectorValue = false;
    }


    void invalidateObjectiveVector()
    {
        invalidObjectiveVectorValue = true;
    }


    bool invalidObjectiveVector() const
    {
        return invalidObjectiveVectorValue;
    }


    Fitness fitness() const
    {
        if ( invalidFitness() )
        {
            throw std::runtime_error("invalid fitness in MOEO");
        }
        return fitnessValue;
    }


    void fitness(const Fitness & _fitnessValue)
    {
        fitnessValue = _fitnessValue;
        invalidFitnessValue = false;
    }


    void invalidateFitness()
    {
        invalidFitnessValue = true;
    }


    bool invalidFitness() const
    {
        return invalidFitnessValue;
    }


    Diversity diversity() const
    {
        if ( invalidDiversity() )
        {
            throw std::runtime_error("invalid diversity in MOEO");
        }
        return diversityValue;
    }


    void diversity(const Diversity & _diversityValue)
    {
        diversityValue = _diversityValue;
        invalidDiversityValue = false;
    }


    void invalidateDiversity()
    {
        invalidDiversityValue = true;
    }


    bool invalidDiversity() const
    {
        return invalidDiversityValue;
    }


    void invalidate()
    {
        invalidateObjectiveVector();
        invalidateFitness();
        invalidateDiversity();
    }


    bool invalid() const
    {
        return invalidObjectiveVector();
    }


    bool operator<(const MOEO & _other) const
    {
        return objectiveVector() < _other.objectiveVector();
    }


    virtual std::string className() const
    {
        return "MOEO";
    }


    virtual void printOn(std::ostream & _os) const
    {
        if ( invalidObjectiveVector() )
        {
            _os << "INVALID\t";
        }
        else
        {
            _os << objectiveVectorValue << '\t';
        }
    }


    virtual void readFrom(std::istream & _is)
    {
        std::string objectiveVector_str;
        int pos = _is.tellg();
        _is >> objectiveVector_str;
        if (objectiveVector_str == "INVALID")
        {
            invalidateObjectiveVector();
        }
        else
        {
            invalidObjectiveVectorValue = false;
            _is.seekg(pos); // rewind
            _is >> objectiveVectorValue;
        }
    }


private:

    ObjectiveVector objectiveVectorValue;
    bool invalidObjectiveVectorValue;
    Fitness fitnessValue;
    bool invalidFitnessValue;
    Diversity diversityValue;
    bool invalidDiversityValue;

};

#endif /*MOEO_H_*/

---