/*
 *  Open BEAGLE
 *  Copyright (C) 2001-2005 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, G1K 7P4
 *  http://vision.gel.ulaval.ca
 *
 */

/*!
 *  \file   beagle/GA/MuWCommaLambdaCMAFltVecOp.hpp
 *  \brief  Definition of the class MuWCommaLambdaCMAFltVecOp.
 *  \author Christian Gagne
 *  \author Marc Parizeau
 *  $Revision: 1.5 $
 *  $Date: 2005/09/30 15:04:53 $
 */


#ifndef Beagle_GA_MuWCommaLambdaCMAFltVecOp_hpp
#define Beagle_GA_MuWCommaLambdaCMAFltVecOp_hpp

#include "beagle/config.hpp"
#include "beagle/macros.hpp"
#include "beagle/Object.hpp"
#include "beagle/Pointer.hpp"
#include "beagle/PointerT.hpp"
#include "beagle/Allocator.hpp"
#include "beagle/AllocatorT.hpp"
#include "beagle/AbstractAllocT.hpp"
#include "beagle/ContainerAllocator.hpp"
#include "beagle/Container.hpp"
#include "beagle/ContainerT.hpp"
#include "beagle/Operator.hpp"
#include "beagle/ReplacementStrategyOp.hpp"
#include "beagle/Float.hpp"
#include "beagle/Matrix.hpp"
#include "beagle/Vector.hpp"

namespace Beagle {
namespace GA {

/*!
 *  \class MuWCommaLambdaCMAFltVecOp beagle/GA/MuWCommaLambdaCMAFltVecOp.hpp "beagle/GA/MuWCommaLambdaCMAFltVecOp.hpp"
 *  \brief CMA-ES (Mu_W+Lambda) replacement strategy operator class.
 *  \ingroup GAF
 *  \ingroup GAFV
 *
 *  CMA-ES (Mu_W,Lambda) replacement strategy class. Apply the CMA-ES algorithm (except mutation)
 *  on a population of GA float vectors. Use in conjunction of the CMA-ES mutation operator
 *  defined in class GA::MutationCMAFltVecOp.
 *
 *  Reference: Hansen, N. and Ostermeier, A. (2001). Completely Derandomized Self-Adaptation
 *  in Evolution Strategies. Evolutionary Computation, 9(2), pp. 159-195.
 *  See also: http://www.bionik.tu-berlin.de/user/niko/cmaes_inmatlab.html
 */
class MuWCommaLambdaCMAFltVecOp : public MuCommaLambdaOp {

public:

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

  explicit MuWCommaLambdaCMAFltVecOp(string inLMRatioName="ga.cmaes.mulambdaratio",
                                     string inName="GA-MuWCommaLambdaCMAFltVecOp");
  virtual ~MuWCommaLambdaCMAFltVecOp() { }

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

protected:

  Matrix::Handle       mB;                //!< CMA-ES B matrix.
  Vector::Handle       mD;                //!< CMA-ES D matrix.
  Vector::Handle       mPC;               //!< CMA-ES P_c cumulation path.
  Vector::Handle       mPS;               //!< CMA-ES P_s cumulation path.
  Double::Handle       mSigma;            //!< CMA-ES sigma value.
  Vector::Handle       mXmean;            //!< Mean float vector individual.
  DoubleArray::Handle  mMaxValue;         //!< Maximum float vector values.
  DoubleArray::Handle  mMinValue;         //!< Minimum float vector values.

};

}
}

#endif // Beagle_GA_MuWCommaLambdaCMAFltVecOp_hpp


