/* 
* <moSteadyFitSolContinue.h>
* Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2007
* (C) OPAC Team, LIFL, 2002-2007
*
* Sébastien Cahon, Jean-Charles Boisson (Jean-Charles.Boisson@lifl.fr)
*
* 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 __moSteadyFitSolContinue_h
#define __moSteadyFitSolContinue_h

#include "moSolContinue.h"

//! One possible stopping criterion for a solution-based heuristic.
/*!
  The stop criterion corresponds to a maximum number of iterations without improvement (after a minimum number of iterations).
 */
template < class EOT > class moSteadyFitSolContinue:public moSolContinue < EOT >
{

public:

  //! Alias for the fitness.
  typedef typename EOT::Fitness Fitness;

  //! Basic constructor.
  /*!
     \param __maxNumberOfIterations The number of iterations to reach before looking for the fitness.
     \param __maxNumberOfIterationWithoutImprovement The number of iterations without fitness improvement to reach for stop.
   */
  moSteadyFitSolContinue (unsigned int __maxNumberOfIterations, unsigned int __maxNumberOfIterationWithoutImprovement)
    : maxNumberOfIterations (__maxNumberOfIterations), maxNumberOfIterationsWithoutImprovement(__maxNumberOfIterationWithoutImprovement),
      maxNumberOfIterationsReached(false), firstFitnessSaved(true), counter(0) 
  {}

  //! Function that activates the stopping criterion.
  /*!
    Indicates if the fitness has not been improved since a number of iterations (after a minimum of iterations).

     \param __sol the current solution.
     \return true or false.
   */
  bool operator   () (const EOT & __sol)
  {
    if(!maxNumberOfIterationsReached)
      {
	maxNumberOfIterationsReached=((++counter)==maxNumberOfIterations);
	if(maxNumberOfIterationsReached)
	  {
	    std::cout << "moSteadyFitSolContinue: Done the minimum number of iterations [" << counter << "]." << std::endl;
	  }
	return true;
      }

    if(__sol.invalid())
      {
	return true;
      }

    if(firstFitnessSaved)
      {
	fitness=__sol.fitness();
	counter=0;
	firstFitnessSaved=false;
	return true;
      }
    
    counter++;

    if( __sol.fitness() > fitness )
      {
	fitness=__sol.fitness();
	counter=0;
      }
  
    if(counter==maxNumberOfIterationsWithoutImprovement)
      {
	std::cout << "moSteadyFitSolContinue: Done [" << counter  << "] iterations without improvement." << std::endl;
      }
    return counter!=maxNumberOfIterationsWithoutImprovement;
  }

  //! Procedure which allows to initialise the stuff needed.
  /*!
    It can be also used to reinitialize the counter all the needed things.
  */
  void init ()
  {
    maxNumberOfIterationsReached=false;
    counter=0;
    firstFitnessSaved=true;
  }

private:

  //! Maximum number of iterations before considering the fitness.
  unsigned int maxNumberOfIterations;

   //! Maximum number of iterations without improvement allowed.
  unsigned int maxNumberOfIterationsWithoutImprovement;

  //! Flag that indicates that the maxNumberIteration have been reached.
  bool maxNumberOfIterationsReached;

  //! Flag that this is the first time that the fitness is used.
  bool firstFitnessSaved;

  //! Current Fitness.
  Fitness fitness;

  //! The iteration couter.
  unsigned int counter;
};

#endif