double.hpp

非常好的进化算法EC 实现平台 可以实现多种算法 GA GP

/*
 *  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/Double.hpp
 *  \brief  Definition of the type Double and related operators.
 *  \author Christian Gagne
 *  \author Marc Parizeau
 *  $Revision: 1.7 $
 *  $Date: 2005/09/30 15:04:54 $
 */

#ifndef Beagle_Double_hpp
#define Beagle_Double_hpp

#include "beagle/config.hpp"
#include "beagle/macros.hpp"
#include "beagle/WrapperT.hpp"
#include "beagle/ArrayT.hpp"


namespace Beagle {

/*!
 *  \brief Beagle wrapper of the atomic double type.
 *  \ingroup Adapt
 */
typedef WrapperT< double >
        Double;

/*!
 *  \brief Beagle array of the atomic double type.
 *  \ingroup Adapt
 */
typedef ArrayT< double >
        DoubleArray;

/*!
 *  \brief Evaluate absolute value of a Beagle::Double.
 *  \param inValue Double to evaluate the absolute value.
 *  \return Absolute value of the input.
 *  \ingroup Adapt
 */
template <>
inline Double absolute(const Double& inValue)
{
  Beagle_StackTraceBeginM();
  return Double(std::fabs(inValue.getWrappedValue()));
  Beagle_StackTraceEndM("Double absolute(const Double& inValue)");
}

}


/*!
 *  \brief  Test whether an double is less than another.
 *  \param  inLeftDouble  Left double compared.
 *  \param  inRightDouble Right double compared.
 *  \return True if left double is less than the right one, false if not.
 *  \par Note:
 *    The operator is defined relatively to the function isLess of Beagle::Double.
 */
inline bool operator<(const Beagle::Double& inLeftDouble, const Beagle::Double& inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inLeftDouble.isLess(inRightDouble);
  Beagle_StackTraceEndM("bool operator<(const Double& inLeftDouble, const Double& inRightDouble)");
}


/*!
 *  \brief  Test whether an double is less than, or equal to another.
 *  \param  inLeftDouble  Left double compared.
 *  \param  inRightDouble Right double compared.
 *  \return True if left double is less than, or equal to the right one, false if not.
 *  \par Note:
 *    The operator is defined relatively to the functions isLess and isEqual of Beagle::Double.
 */
inline bool operator<=(const Beagle::Double& inLeftDouble, const Beagle::Double& inRightDouble)
{
  Beagle_StackTraceBeginM();
  return ( inLeftDouble.isLess(inRightDouble) || inLeftDouble.isEqual(inRightDouble) );
  Beagle_StackTraceEndM("bool operator<=(const Double& inLeftDouble, const Double& inRightDouble)");
}


/*!
 *  \brief  Test whether an double is more than another.
 *  \param  inLeftDouble  Left double compared.
 *  \param  inRightDouble Right double compared.
 *  \return True if left double is more than the right one, false if not.
 *  \par Note:
 *    The operator is defined relatively to the function isLess of Beagle::Double.
 */
inline bool operator>(const Beagle::Double& inLeftDouble, const Beagle::Double& inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inRightDouble.isLess(inLeftDouble);
  Beagle_StackTraceEndM("bool operator>(const Double& inLeftDouble, const Double& inRightDouble)");
}


/*!
 *  \brief  Test whether an double is more than, or equal to another.
 *  \param  inLeftDouble  Left double compared.
 *  \param  inRightDouble Right double compared.
 *  \return True if left double is more than, or equal to the right one, false if not.
 *  \par Note:
 *    The operator is defined relatively to the functions isLess and isEqual of Beagle::Double.
 */
inline bool operator>=(const Beagle::Double& inLeftDouble, const Beagle::Double& inRightDouble)
{
  Beagle_StackTraceBeginM();
  return ( inRightDouble.isLess(inLeftDouble) || inLeftDouble.isEqual(inRightDouble) );
  Beagle_StackTraceEndM("bool operator>=(const Double& inLeftDouble, const Double& inRightDouble)");
}


/*!
 *  \brief  Test whether an double is equal to another.
 *  \param  inLeftDouble  Left double compared.
 *  \param  inRightDouble Right double compared.
 *  \return True if left double is equal to the right one, false if not.
 *  \par Note:
 *    The operator is defined relatively to the function isEqual of Beagle::Double.
 */
inline bool operator==(const Beagle::Double& inLeftDouble, const Beagle::Double& inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inLeftDouble.isEqual(inRightDouble);
  Beagle_StackTraceEndM("bool operator==(const Double& inLeftDouble, const Double& inRightDouble)");
}


/*!
 *  \brief  Test whether an double is not equal to another.
 *  \param  inLeftDouble  Left double compared.
 *  \param  inRightDouble Right double compared.
 *  \return True if left double is not equal to the right one, false if it is.
 *  \par Note:
 *    The operator is defined relatively to the function isEqual of Beagle::Double.
 */
inline bool operator!=(const Beagle::Double& inLeftDouble, const Beagle::Double& inRightDouble)
{
  Beagle_StackTraceBeginM();
  return ( inLeftDouble.isEqual(inRightDouble) == false);
  Beagle_StackTraceEndM("bool operator!=(const Double& inLeftDouble, const Double& inRightDouble)");
}


/*!
 *  \brief Compare equality of a Double with a double.
 *  \param inLeftDouble Left value to compare.
 *  \param inRightDouble Right value to compare.
 *  \return Result of the comparison.
 */
inline
bool operator==(const Beagle::Double& inLeftDouble, double inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inLeftDouble.getWrappedValue() == inRightDouble;
  Beagle_StackTraceEndM("bool operator==(const Double& inLeftDouble, double inRightDouble)");
}


/*!
 *  \brief Compare inequality of a Double with a double.
 *  \param inLeftDouble Left value to compare.
 *  \param inRightDouble Right value to compare.
 *  \return Result of the comparison.
 */
inline
bool operator!=(const Beagle::Double& inLeftDouble, double inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inLeftDouble.getWrappedValue() != inRightDouble;
  Beagle_StackTraceEndM("bool operator!=(const Double& inLeftDouble, double inRightDouble)");
}


/*!
 *  \brief Test if a Double is < than a double.
 *  \param inLeftDouble Left value to compare.
 *  \param inRightDouble Right value to compare.
 *  \return Result of the comparison.
 */
inline
bool operator<(const Beagle::Double& inLeftDouble, double inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inLeftDouble.getWrappedValue() < inRightDouble;
  Beagle_StackTraceEndM("ool operator<(const Double& inLeftDouble, double inRightDouble)");
}


/*!
 *  \brief Test if a Double is <= than a double.
 *  \param inLeftDouble Left value to compare.
 *  \param inRightDouble Right value to compare.
 *  \return Result of the comparison.
 */
inline
bool operator<=(const Beagle::Double& inLeftDouble, double inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inLeftDouble.getWrappedValue() <= inRightDouble;
  Beagle_StackTraceEndM("bool operator<=(const Double& inLeftDouble, double inRightDouble)");
}


/*!
 *  \brief Test if a Double is > than a double.
 *  \param inLeftDouble Left value to compare.
 *  \param inRightDouble Right value to compare.
 *  \return Result of the comparison.
 */
inline
bool operator>(const Beagle::Double& inLeftDouble, double inRightDouble)
{
  Beagle_StackTraceBeginM();
  return inLeftDouble.getWrappedValue() > inRightDouble;
  Beagle_StackTraceEndM("bool operator>(const Double& inLeftDouble, double inRightDouble)");
}


/*!
 *  \brief Test if a Double is >= than a double.
 *  \param inLeftDouble Left value to compare.
 *  \param inRightDouble Right value to compare.
 *  \return Result of the comparison.
 */
inline
bool operator>=(const Beagle::Double& inLeftDouble, double inRightDouble)
{
  Beagle_StackTraceBeginM();