UserFunction1D.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidCurveFitting/Algorithms/Fit1D.h"
#include "MantidGeometry/muParser_Silent.h"
 
namespace Mantid {
namespace CurveFitting {
namespace Functions {
class UserFunction1D : public Algorithms::Fit1D {
public:
  UserFunction1D() : m_x(0.0), m_x_set(false), m_parameters(100), m_nPars(0){};
  const std::string name() const override { return "UserFunction1D"; }
  int version() const override { return (1); }
  const std::string category() const override { return "Optimization\\FitAlgorithms"; }
  const std::string summary() const override { return "Fits a histogram from a workspace to a user defined function."; }
  const std::vector<std::string> seeAlso() const override { return {"Fit"}; }
 
protected:
  // double function(const double* in, const double& x);
  void function(const double *in, double *out, const double *xValues, const size_t nData) override;
  void declareAdditionalProperties() override;
  void declareParameters() override{};
  void prepare() override;
  void functionDeriv(const double *in, API::Jacobian *out, const double *xValues, const size_t nData) override;
 
  static double *AddVariable(const char *varName, void *palg);
 
private:
  mu::Parser m_parser;
  double m_x;
  bool m_x_set;
  std::vector<double> m_parameters;
  int m_nPars;
  std::vector<double> m_tmp;
  std::vector<double> m_tmp1;
};
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid