IFunction1D.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/FunctionDomain1D.h"
#include "MantidAPI/IFunction.h"
 
namespace Mantid {
 
namespace CurveFitting {
namespace Algorithms {
class Fit;
}
} // namespace CurveFitting
namespace API {
 
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class MatrixWorkspace;
class Jacobian;
class ParameterTie;
class IConstraint;
class ParameterReference;
class FunctionHandler;
class MANTID_API_DLL IFunction1D : public virtual IFunction {
public:
  /* Overidden methods */
 
  void function(const FunctionDomain &domain, FunctionValues &values) const override;
  void functionDeriv(const FunctionDomain &domain, Jacobian &jacobian) override;
 
  virtual void derivative(const FunctionDomain &domain, FunctionValues &values, const size_t order = 1) const;
 
  virtual void function1D(double *out, const double *xValues, const size_t nData) const = 0;
 
  virtual void derivative1D(double *out, const double *xValues, const size_t nData, const size_t order) const;
 
  virtual void functionDeriv1D(Jacobian *jacobian, const double *xValues, const size_t nData);
 
protected:
  template <typename FunctionType>
  using Function1DMethod = void (FunctionType::*)(double *, const double *, const size_t) const;
  template <typename EvaluationMethod>
  void calcNumericalDerivative1D(Jacobian *jacobian, EvaluationMethod func1D, const double *xValues,
                                 const size_t nData);
  virtual void histogram1D(double *out, double left, const double *right, const size_t nBins) const;
  virtual void histogramDerivative1D(Jacobian *jacobian, double left, const double *right, const size_t nBins) const;
 
  friend class CurveFitting::Algorithms::Fit;
};
 
using IFunction1D_sptr = std::shared_ptr<IFunction1D>;
 
} // namespace API
} // namespace Mantid