MOEO.h

/* 
* <MOEO.h>
* Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2007
* (C) OPAC Team, LIFL, 2002-2007
*
* Arnaud Liefooghe
*
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software.  You can  use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and  rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty  and the software's author,  the holder of the
* economic rights,  and the successive licensors  have only  limited liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading,  using,  modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean  that it is complicated to manipulate,  and  that  also
* therefore means  that it is reserved for developers  and  experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and,  more generally, to use and operate it in the
* same conditions as regards security.
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
*
* ParadisEO WebSite : http://paradiseo.gforge.inria.fr
* Contact: paradiseo-help@lists.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_*/

---