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

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

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

#ifndef MOEOSELECTONEFROMPOPANDARCH_H_
#define MOEOSELECTONEFROMPOPANDARCH_H_

#include <eoPop.h>
#include <utils/eoRNG.h>
#include <moeoArchive.h>
#include <moeoSelectOne.h>
#include <moeoRandomSelect.h>

/**
 * Elitist selection process that consists in choosing individuals in the archive as well as in the current population.
 */
template < class MOEOT >
class moeoSelectFromPopAndArch : public moeoSelectOne < MOEOT >
{
public:

    /**
     * Ctor
     * @param _popSelectOne the population's selection operator
     * @param _archSelectOne the archive's selection operator
     * @param _arch the archive
     * @param _ratioFromPop the ratio of selected individuals from the population
     */
    moeoSelectFromPopAndArch (moeoSelectOne < MOEOT > & _popSelectOne, moeoSelectOne < MOEOT > _archSelectOne, moeoArchive < MOEOT > & _arch, double _ratioFromPop=0.5)
            : popSelectOne(_popSelectOne), archSelectOne(_archSelectOne), arch(_arch), ratioFromPop(_ratioFromPop)
    {}

    /**
     * Defaulr ctor - the archive's selection operator is a random selector
     * @param _popSelectOne the population's selection operator	
     * @param _arch the archive
     * @param _ratioFromPop the ratio of selected individuals from the population
     */
    moeoSelectFromPopAndArch (moeoSelectOne < MOEOT > & _popSelectOne, moeoArchive < MOEOT > & _arch, double _ratioFromPop=0.5)
            : popSelectOne(_popSelectOne), archSelectOne(randomSelectOne), arch(_arch), ratioFromPop(_ratioFromPop)
    {}

    /**
     * The selection process
     */
    virtual const MOEOT & operator () (const eoPop < MOEOT > & pop)
    {
        if (arch.size() > 0)
            if (rng.flip(ratioFromPop))
                return popSelectOne(pop);
            else
                return archSelectOne(arch);
        else
            return popSelectOne(pop);
    }

    /**
     * Setups some population stats
     */
    virtual void setup (const eoPop < MOEOT > & _pop)
    {
        popSelectOne.setup(_pop);
    }


private:

    /** The population's selection operator */
    moeoSelectOne < MOEOT > & popSelectOne;
    /** The archive's selection operator */
    moeoSelectOne < MOEOT > & archSelectOne;
    /** The archive */
    moeoArchive < MOEOT > & arch;
    /** The ratio of selected individuals from the population*/
    double ratioFromPop;
    /** A random selection operator (used as default for archSelectOne) */
    moeoRandomSelect < MOEOT > randomSelectOne;

};

#endif /*MOEOSELECTONEFROMPOPANDARCH_H_*/