Functions.h

Go to the documentation of this file.

//
// File: Functions.h
// Authors:
//   Julien Dutheil
// Created: 2003-11-09 23:11:00
//
 
/*
  Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
  
  This software is a computer program whose purpose is to provide classes
  for numerical calculus.
  
  This software is governed by the CeCILL license under French law and
  abiding by the rules of distribution of free software. You can use,
  modify and/ or redistribute the software under the terms of the CeCILL
  license as circulated by CEA, CNRS and INRIA at the following URL
  "http://www.cecill.info".
  
  As a counterpart to the access to the source code and rights to copy,
  modify and redistribute granted by the license, users are provided only
  with a limited warranty and the software's author, the holder of the
  economic rights, and the successive licensors have only limited
  liability.
  
  In this respect, the user's attention is drawn to the risks associated
  with loading, using, modifying and/or developing or reproducing the
  software by the user in light of its specific status of free software,
  that may mean that it is complicated to manipulate, and that also
  therefore means that it is reserved for developers and experienced
  professionals having in-depth computer knowledge. Users are therefore
  encouraged to load and test the software's suitability as regards their
  requirements in conditions enabling the security of their systems and/or
  data to be ensured and, more generally, to use and operate it in the
  same conditions as regards security.
  
  The fact that you are presently reading this means that you have had
  knowledge of the CeCILL license and that you accept its terms.
*/
 
#ifndef BPP_NUMERIC_FUNCTION_FUNCTIONS_H
#define BPP_NUMERIC_FUNCTION_FUNCTIONS_H
 
 
#include "../AbstractParametrizable.h"
#include "../ParameterExceptions.h"
#include "../ParameterList.h"
#include "../Parametrizable.h"
 
// From Utils:
#include "../../Clonable.h"
#include "../../Exceptions.h"
 
// From the STL:
#include <cmath>
 
namespace bpp
{
class Function :
  public virtual Parametrizable
{
public:
  Function() {}
  virtual ~Function() {}
 
public:
  virtual void setParameters(const ParameterList& parameters) = 0;
 
  virtual double getValue() const = 0;
 
  virtual double f(const ParameterList& parameters)
  {
    setParameters(parameters);
    return getValue();
  }
 
  friend class FunctionWrapper;
};
 
class DerivableFirstOrder :
  public virtual Function
{
public:
  DerivableFirstOrder() {}
  virtual ~DerivableFirstOrder() {}
 
  DerivableFirstOrder* clone() const = 0;
 
public:
  virtual void enableFirstOrderDerivatives(bool yn) = 0;
 
  virtual bool enableFirstOrderDerivatives() const = 0;
 
  virtual double getFirstOrderDerivative(const std::string& variable) const = 0;
 
  virtual double df(const std::string& variable, const ParameterList& parameters)
  {
    setParameters(parameters);
    return getFirstOrderDerivative(variable);
  }
};
 
class DerivableSecondOrder :
  public virtual DerivableFirstOrder
{
public:
  DerivableSecondOrder() {}
  virtual ~DerivableSecondOrder() {}
 
  DerivableSecondOrder* clone() const = 0;
 
public:
  virtual void enableSecondOrderDerivatives(bool yn) = 0;
 
  virtual bool enableSecondOrderDerivatives() const = 0;
 
  virtual double getSecondOrderDerivative(const std::string& variable) const = 0;
 
  virtual double d2f(const std::string& variable, const ParameterList& parameters)
  {
    setParameters(parameters);
    return getSecondOrderDerivative(variable);
  }
 
  virtual double getSecondOrderDerivative(const std::string& variable1, const std::string& variable2) const = 0;
 
  virtual double d2f(const std::string& variable1, const std::string& variable2, const ParameterList& parameters)
  {
    setParameters(parameters);
    return getSecondOrderDerivative(variable1, variable2);
  }
};
 
class FunctionWrapper :
  public virtual Function
{
protected:
  Function* function_;
 
public:
  FunctionWrapper(Function* function) : function_(function) {}
  FunctionWrapper(const FunctionWrapper& fw) : function_(fw.function_) {}
  FunctionWrapper& operator=(const FunctionWrapper& fw)
  {
    function_ = fw.function_;
    return *this;
  }
 
public:
  bool hasParameter(const std::string& name) const
  {
    return function_->hasParameter(name);
  }
 
  void setParameters(const ParameterList& parameters)
  {
    function_->setParameters(parameters);
  }
 
  const ParameterList& getParameters() const
  {
    return function_->getParameters();
  }
 
  const Parameter& getParameter(const std::string& name) const
  {
    return function_->getParameter(name);
  }
 
  double getValue() const
  {
    return function_->getValue();
  }
 
  double f(const ParameterList& parameters)
  {
    return function_->f(parameters);
  }
 
  double getParameterValue(const std::string& name) const
  {
    return function_->getParameterValue(name);
  }
 
  void setAllParametersValues(const ParameterList& parameters)
  {
    function_->setAllParametersValues(parameters);
  }
 
  void setParameterValue(const std::string& name, double value)
  {
    function_->setParameterValue(name, value);
  }
 
  void setParametersValues(const ParameterList& parameters)
  {
    function_->setParametersValues(parameters);
  }
 
  bool matchParametersValues(const ParameterList& parameters)
  {
    return function_->matchParametersValues(parameters);
  }
 
  size_t getNumberOfParameters() const
  {
    return function_->getNumberOfParameters();
  }
 
  void setNamespace(const std::string& prefix)
  {
    function_->setNamespace(prefix);
  }
 
  std::string getNamespace() const
  {
    return function_->getNamespace();
  }
 
  std::string getParameterNameWithoutNamespace(const std::string& name) const
  {
    return function_->getParameterNameWithoutNamespace(name);
  }
 
protected:
  ParameterList& getParameters_()
  {
    return function_->getParameters_();
  }
};
 
 
class DerivableFirstOrderWrapper :
  public FunctionWrapper,
  public virtual DerivableFirstOrder
{
public:
  DerivableFirstOrderWrapper(DerivableFirstOrder* function) : FunctionWrapper(function) {}
 
public:
  void enableFirstOrderDerivatives(bool yn)
  {
    dynamic_cast<DerivableFirstOrder*>(function_)->enableFirstOrderDerivatives(yn);
  }
 
  bool enableFirstOrderDerivatives() const
  {
    return dynamic_cast<DerivableFirstOrder*>(function_)->enableFirstOrderDerivatives();
  }
 
  double getFirstOrderDerivative(const std::string& variable) const
  {
    return dynamic_cast<DerivableFirstOrder*>(function_)->getFirstOrderDerivative(variable);
  }
};
 
 
class DerivableSecondOrderWrapper :
  public DerivableFirstOrderWrapper,
  public virtual DerivableSecondOrder
{
public:
  DerivableSecondOrderWrapper(DerivableSecondOrder* function) : DerivableFirstOrderWrapper(function) {}
 
public:
  void enableSecondOrderDerivatives(bool yn)
  {
    dynamic_cast<DerivableSecondOrder*>(function_)->enableSecondOrderDerivatives(yn);
  }
 
  bool enableSecondOrderDerivatives() const
  {
    return dynamic_cast<DerivableSecondOrder*>(function_)->enableSecondOrderDerivatives();
  }
 
  double getSecondOrderDerivative(const std::string& variable) const
  {
    return dynamic_cast<DerivableSecondOrder*>(function_)->getSecondOrderDerivative(variable);
  }
 
  double getSecondOrderDerivative(const std::string& variable1, const std::string& variable2) const
  {
    return dynamic_cast<DerivableSecondOrder*>(function_)->getSecondOrderDerivative(variable1, variable2);
  }
};
 
 
class InfinityFunctionWrapper :
  public FunctionWrapper
{
protected:
  mutable bool constraintMatch_;
 
public:
  InfinityFunctionWrapper(Function* function) :
    FunctionWrapper(function),
    constraintMatch_(false) {}
  virtual ~InfinityFunctionWrapper() {}
 
  InfinityFunctionWrapper* clone() const { return new InfinityFunctionWrapper(*this); }
 
public:
  void setParameters(const ParameterList& parameters)
  {
    try
    {
      function_->setParameters(parameters);
      constraintMatch_ = false;
    }
    catch (ConstraintException& ce)
    {
      constraintMatch_ = true;
    }
  }
 
  double getValue() const
  {
    return constraintMatch_ ? -std::log(0.) :  function_->getValue();
  }
 
  double f(const ParameterList& parameters)
  {
    setParameters(parameters);
    return getValue();
  }
 
  void setAllParametersValues(const ParameterList& parameters)
  {
    try
    {
      function_->setAllParametersValues(parameters);
      constraintMatch_ = false;
    }
    catch (ConstraintException& ce)
    {
      constraintMatch_ = true;
    }
  }
 
  void setParameterValue(const std::string& name, double value)
  {
    try
    {
      function_->setParameterValue(name, value);
      constraintMatch_ = false;
    }
    catch (ConstraintException& ce)
    {
      constraintMatch_ = true;
    }
  }
 
  void setParametersValues(const ParameterList& parameters)
  {
    try
    {
      function_->setParametersValues(parameters);
      constraintMatch_ = false;
    }
    catch (ConstraintException& ce)
    {
      constraintMatch_ = true;
    }
  }
 
  bool matchParametersValues(const ParameterList& parameters)
  {
    try
    {
      bool test = function_->matchParametersValues(parameters);
      constraintMatch_ = false;
      return test;
    }
    catch (ConstraintException& ce)
    {
      constraintMatch_ = true;
      return false;
    }
  }
};
 
class InfinityDerivableFirstOrderWrapper :
  public virtual InfinityFunctionWrapper
{
public:
  InfinityDerivableFirstOrderWrapper(DerivableFirstOrder* function) : InfinityFunctionWrapper(function) {}
  virtual ~InfinityDerivableFirstOrderWrapper() {}
 
  InfinityDerivableFirstOrderWrapper* clone() const { return new InfinityDerivableFirstOrderWrapper(*this); }
 
public:
  double getFirstOrderDerivative(const std::string& variable) const
  {
    return constraintMatch_ ? -std::log(0.) :  (dynamic_cast<DerivableFirstOrder*>(function_)->getFirstOrderDerivative(variable));
  }
 
  double df(const std::string& variable, const ParameterList& parameters)
  {
    setParameters(parameters);
    return getFirstOrderDerivative(variable);
  }
};
 
class InfinityDerivableSecondOrderWrapper :
  public virtual InfinityDerivableFirstOrderWrapper
{
public:
  InfinityDerivableSecondOrderWrapper(DerivableFirstOrder* function) :
    InfinityFunctionWrapper(function),
    InfinityDerivableFirstOrderWrapper(function) {}
  virtual ~InfinityDerivableSecondOrderWrapper() {}
 
  InfinityDerivableSecondOrderWrapper* clone() const { return new InfinityDerivableSecondOrderWrapper(*this); }
 
public:
  double getSecondOrderDerivative(const std::string& variable) const
  {
    return constraintMatch_ ? -std::log(0.) :  (dynamic_cast<DerivableSecondOrder*>(function_)->getSecondOrderDerivative(variable));
  }
 
  double d2f(const std::string& variable, const ParameterList& parameters)
  {
    setParameters(parameters);
    return getSecondOrderDerivative(variable);
  }
 
  double getSecondOrderDerivative(const std::string& variable1, const std::string& variable2) const
  {
    return constraintMatch_ ? -std::log(0.) :  (dynamic_cast<DerivableSecondOrder*>(function_)->getSecondOrderDerivative(variable1, variable2));
  }
 
  double d2f(const std::string& variable1, const std::string& variable2, const ParameterList& parameters)
  {
    setParameters(parameters);
    return getSecondOrderDerivative(variable1, variable2);
  }
};
 
 
class TestFunction :
  public virtual Function,
  public AbstractParametrizable
{
public:
  TestFunction(double x = 0, double y = 0) :
    AbstractParametrizable("")
  {
    addParameter_(new Parameter("x", x));
    addParameter_(new Parameter("y", y));
  }
 
  Clonable* clone() const { return new TestFunction(*this); }
 
  void setParameters(const ParameterList& parameters)
  {
    matchParametersValues(parameters);
  }
 
  double getValue() const
  {
    double x = getParameter("x").getValue();
    double y = getParameter("y").getValue();
    return x * x + y * y;
  }
 
  void fireParameterChanged(const ParameterList& parameters) {}
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_FUNCTION_FUNCTIONS_H