/*
* <moImprBestFitAspirCrit.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 __moImprBestFitAspirCrit_h
#define __moImprBestFitAspirCrit_h

#include "moAspirCrit.h"

//! One of the possible moAspirCrit
/*!
  This criterion is satisfied when a given fitness
  is the best ever considered.
*/
template < class M > class moImprBestFitAspirCrit:public moAspirCrit < M >
  {

  public:

    //! Alias for the fitness
    typedef typename M::EOType::Fitness Fitness;

    //! Contructor
    moImprBestFitAspirCrit ()
    {

      first_time = true;
    }

    //! Initialisation procedure
    void init ()
    {

      first_time = true;
    }

    //! Function that indicates if the fit is better that the already saved fit
    /*!
       The first time, the function only saved the current move and fitness.

       \param __move a move.
       \param __fit a fitnes linked to the move.
       \return TRUE the first time and if __fit > best_fit, else FALSE.
     */
    bool operator   () (const M & __move, const Fitness & __fit)
    {

      if (first_time)
        {

          best_fit = __fit;
          first_time = false;

          return true;
        }
      else if (__fit < best_fit)
        return false;

      else
        {

          best_fit = __fit;

          return true;
        }
    }

  private:

    //! Best fitness found until now
    Fitness best_fit;

    //! Indicates that a fitness has been already saved or not
    bool first_time;
  };

#endif