FivePointsNumericalDerivative.h

Go to the documentation of this file.

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

#ifndef BPP_NUMERIC_FUNCTION_FIVEPOINTSNUMERICALDERIVATIVE_H
#define BPP_NUMERIC_FUNCTION_FIVEPOINTSNUMERICALDERIVATIVE_H


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

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

namespace bpp
{
class FivePointsNumericalDerivative :
  public AbstractNumericalDerivative
{
private:
  double f1_, f2_, f3_, f4_, f5_;

public:
  FivePointsNumericalDerivative(std::shared_ptr<FunctionInterface> function) :
    AbstractNumericalDerivative(function),
    f1_(),
    f2_(),
    f3_(),
    f4_(),
    f5_() {}
  FivePointsNumericalDerivative(std::shared_ptr<FirstOrderDerivable> function) :
    AbstractNumericalDerivative(function),
    f1_(),
    f2_(),
    f3_(),
    f4_(),
    f5_() {}
  FivePointsNumericalDerivative(std::shared_ptr<SecondOrderDerivable> function) :
    AbstractNumericalDerivative(function),
    f1_(),
    f2_(),
    f3_(),
    f4_(),
    f5_() {}
  virtual ~FivePointsNumericalDerivative() {}

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

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

  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_FIVEPOINTSNUMERICALDERIVATIVE_H