TwoPointsNumericalDerivative.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_NUMERIC_FUNCTION_TWOPOINTSNUMERICALDERIVATIVE_H
#define BPP_NUMERIC_FUNCTION_TWOPOINTSNUMERICALDERIVATIVE_H


#include "NumericalDerivative.h"
#include "Functions.h"

// From the STL:
#include <map>
#include <vector>
#include <string>

namespace bpp
{
class TwoPointsNumericalDerivative :
  public AbstractNumericalDerivative
{
private:
  double f1_, f2_;

public:
  TwoPointsNumericalDerivative(std::shared_ptr<FunctionInterface> function) :
    AbstractNumericalDerivative(function),
    f1_(),
    f2_() {}
  TwoPointsNumericalDerivative(std::shared_ptr<FirstOrderDerivable> function) :
    AbstractNumericalDerivative(function),
    f1_(),
    f2_() {}
  virtual ~TwoPointsNumericalDerivative() {}

  TwoPointsNumericalDerivative* clone() const override
  {
    return new TwoPointsNumericalDerivative(*this);
  }

public:
  double getValue() const override { return f1_; }

  double getSecondOrderDerivative(const std::string& variable) const override
  {
    throw Exception("Second order derivative not avalaible with two points method.");
  }

  double getSecondOrderDerivative(const std::string& variable1, const std::string& variable2) const override
  {
    throw Exception("Unimplemented cross derivative.");
  }
protected:
  void updateDerivatives(const ParameterList& parameters) override;
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_FUNCTION_TWOPOINTSNUMERICALDERIVATIVE_H