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

#ifndef Beagle_GA_InitBitStrOp_hpp
#define Beagle_GA_InitBitStrOp_hpp

#include <string>

#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/InitializationOp.hpp"
#include "beagle/Float.hpp"

namespace Beagle {
namespace GA {

/*!
 *  \class InitBitStrOp beagle/GA/InitBitStrOp.hpp "beagle/GA/InitBitStrOp.hpp"
 *  \brief GA bit string initialization operator class.
 *  \ingroup GAF
 *  \ingroup GABS
 */
class InitBitStrOp : public InitializationOp {

public:

  //! GA::InitBitStrOp allocator type.
  typedef AllocatorT<InitBitStrOp,InitializationOp::Alloc>
          Alloc;
  //! GA::InitBitStrOp handle type.
  typedef PointerT<InitBitStrOp,InitializationOp::Handle>
          Handle;
  //! GA::InitBitStrOp bag type.
  typedef ContainerT<InitBitStrOp,InitializationOp::Bag>
          Bag;

  explicit InitBitStrOp(IntegerVector inBitStringSize=IntegerVector(),
                        std::string inName="GA-InitBitStrOp");
  virtual ~InitBitStrOp() { }

  virtual void initialize(System& ioSystem);
  virtual void initIndividual(Individual& outIndividual, Context& ioContext);

  /*!
   *  \return Bit string size to use for initialization.
   */
  const IntegerVector& getBitStringSize() const
  {
    return *mBitStringSize;
  }
  
  /*!
   *  \return Bit string size to use for initialization.
   */
  IntegerVector& getBitStringSize()
  {
    return *mBitStringSize;
  }
  
protected:
  IntegerVector::Handle mBitStringSize;  //!< Individual bit string size.
  Float::Handle         mBitOneProba;    //!< Probability that a bit is initialized to one.
  
};

}
}

#endif // Beagle_GA_InitBitStrOp_hpp
