/*
 *  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/GP/MutationStandardOp.hpp
 *  \brief  Definition of the class GP::MutationStandardOp.
 *  \author Christian Gagne
 *  \author Marc Parizeau
 *  $Revision: 1.2 $
 *  $Date: 2004/01/15 21:08:56 $
 */

#ifndef Beagle_GP_MutationStandardOp_hpp
#define Beagle_GP_MutationStandardOp_hpp

#include <string>

#include "beagle/config.hpp"
#include "beagle/macros.hpp"
#include "beagle/Object.hpp"
#include "beagle/MutationOp.hpp"
#include "beagle/UInt.hpp"
#include "beagle/Float.hpp"
#include "beagle/Bool.hpp"
#include "beagle/GP/Context.hpp"
#include "beagle/GP/System.hpp"
#include "beagle/GP/Individual.hpp"

namespace Beagle {
namespace GP {

/*!
 *  \class MutationStandardOp beagle/GP/MutationStandardOp.hpp "beagle/GP/MutationStandardOp.hpp"
 *  \brief GP standard mutation operator class, as described in Genetic Programming I.
 *  \ingroup GPF
 *  \ingroup GPOp
 */
class MutationStandardOp : public Beagle::MutationOp {

public:

  //! GP::MutationStandardOp allocator type.
  typedef AllocatorT<MutationStandardOp,Beagle::MutationOp::Alloc>
          Alloc;
  //! GP::MutationStandardOp handle type.
  typedef PointerT<MutationStandardOp,Beagle::MutationOp::Handle>
          Handle;
  //! GP::MutationStandardOp bag type.
  typedef ContainerT<MutationStandardOp,Beagle::MutationOp::Bag>
          Bag;

  explicit MutationStandardOp(std::string inMutationPbName="gp.mutstd.indpb",
                              std::string inMaxRegenDepthName="gp.mutstd.maxdepth",
                              std::string inName="GP-MutationStandardOp");
  virtual ~MutationStandardOp() { }

  virtual void initialize(Beagle::System& ioSystem);
  virtual bool mutate(Beagle::Individual& ioIndividual, Beagle::Context& ioContext);
  virtual void readWithMap(XMLNode::Handle& inNode, OperatorMap& inOpMap);
  virtual void writeContent(XMLStreamer& ioStreamer) const;
  
protected:
  unsigned int initSubTreeGrow(GP::Tree& ioTree,
                               unsigned int inMinDepth,
                               unsigned int inMaxDepth,
                               GP::Context& ioContext) const;

  UInt::Handle  mMaxRegenerationDepth;  //!< Maximum depth of regeneration during mutation.
  UInt::Handle  mMaxTreeDepth;          //!< Maximum allowed depth of trees.
  std::string   mMaxRegenDepthName;     //!< Maximum depth of regeneration parameter name.

};

}
}

#endif // Beagle_GP_MutationStandardOp_hpp
