/*
 *  Open BEAGLE
 *  Copyright (C) 2001-2004 by Christian Gagne and Marc Parizeau
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact:
 *  Laboratoire de Vision et Systemes Numeriques
 *  Departement de genie electrique et de genie informatique
 *  Universite Laval, Quebec, Canada, G1V 4J7
 *  http://vision.gel.ulaval.ca
 *
 */

/*!
 *  \file   beagle/ParetoFrontCalculateOp.hpp
 *  \brief  Definition of the class ParetoFrontCalculateOp.
 *  \author Christian Gagne
 *  \author Marc Parizeau
 *  $Revision: 1.2 $
 *  $Date: 2004/01/15 21:08:57 $
 */

#ifndef Beagle_ParetoFrontCalculateOp_hpp
#define Beagle_ParetoFrontCalculateOp_hpp

#include "beagle/config.hpp"
#include "beagle/macros.hpp"
#include "beagle/Object.hpp"
#include "beagle/AllocatorT.hpp"
#include "beagle/PointerT.hpp"
#include "beagle/ContainerT.hpp"
#include "beagle/WrapperT.hpp"
#include "beagle/Operator.hpp"
#include "beagle/IntegerVector.hpp"
#include "beagle/String.hpp"
#include "beagle/Bool.hpp"
#include "beagle/UInt.hpp"
#include "beagle/Vivarium.hpp"
#include "beagle/Context.hpp"

namespace Beagle {

/*!
 *  \class ParetoFrontCalculateOp beagle/ParetoFrontCalculateOp.hpp "beagle/ParetoFrontCalculateOp.hpp"
 *  \brief Evaluate Pareto front operator class.
 *  \ingroup ECF
 *  \ingroup Op
 *
 *  Evaluate Pareto front from demes and vivarium and put it in place of the actual hall-of-fame.
 *  The Pareto front is evaluated just before milestones are written. If previous hall-of-fame are
 *  presents in the demes/vivarium, they are erased. This operator must be in the evolver's operator
 *  sets between the termination criterion check operators and the MilestoneWriteOp operator.
 */
class ParetoFrontCalculateOp : public Operator {

public:

  //! ParetoFrontCalculateOp allocator type
  typedef AllocatorT<ParetoFrontCalculateOp,Operator::Alloc>
          Alloc;
  //! ParetoFrontCalculateOp handle type.
  typedef PointerT<ParetoFrontCalculateOp,Operator::Handle>
          Handle;
  //! ParetoFrontCalculateOp bag type.
  typedef ContainerT<ParetoFrontCalculateOp,Operator::Bag>
          Bag;

  explicit ParetoFrontCalculateOp(std::string inName="ParetoFrontCalculateOp");
  virtual ~ParetoFrontCalculateOp() { }

  virtual void initialize(System& ioSystem);
  virtual void operate(Deme& ioDeme, Context& ioContext);

private:
  String::Handle        mMilestonePrefix;     //!< Prefix of the milestone filenames.
  UInt::Handle          mWritingInterval;     //!< Milestone's writing interval (in generation).
  Bool::Handle          mPerDemeMilestone;    //!< True: write a milestone for every deme.
  IntegerVector::Handle mPopSize;             //!< Population size for the evolution.

};

}

#endif // Beagle_ParetoFrontCalculateOp_hpp
